> ## Documentation Index > Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Connection > Returns the specified connection. NsApiSlow threshold: 5000 ms. ## OpenAPI ````yaml /openapi/agent/openapi-v3-QuoteAgent.json post /api/v1/Agents/Quote/GetConnection openapi: 3.0.0 info: version: v1-Agents title: SuperOffice Agent API v1 description: SuperOffice Agent API - QuoteAgent contact: name: SuperOffice DevNet url: https://docs.superoffice.com/en/api/index.html email: sdk@superoffice.com servers: - url: http://localhost:56350 - url: https://localhost:56350 security: [] tags: [] externalDocs: description: >- The SuperOffice DevNet Community has more documentation, examples, and discussion forums. url: https://community.superoffice.com/en/developer/ paths: /api/v1/Agents/Quote/GetConnection: post: tags: - Quote_Agent summary: Get Connection description: |- Returns the specified connection. NsApiSlow threshold: 5000 ms. operationId: v1QuoteAgent_GetConnection parameters: - name: $select in: query description: >- Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields. required: false schema: type: string - name: Accept-Language in: header description: >- Convert string references and multi-language values into a specified language (iso2) code. required: false schema: type: string - name: SO-Language in: header description: >- Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value. required: false schema: type: string - name: SO-Culture in: header description: >- Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set. required: false schema: type: string - name: SO-TimeZone in: header description: >- Specify the timezone code that you would like date/time responses converted to. required: false schema: type: string - name: SO-AppToken in: header description: >- The application token that identifies the partner app. Used when calling Online WebAPI from a server. required: false schema: type: string requestBody: content: application/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.QuoteCarriers.GetConnectionRequest text/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.QuoteCarriers.GetConnectionRequest application/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.QuoteCarriers.GetConnectionRequest text/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.QuoteCarriers.GetConnectionRequest application/x-www-form-urlencoded: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.QuoteCarriers.GetConnectionRequest application/json-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.QuoteCarriers.GetConnectionRequest application/merge-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.QuoteCarriers.GetConnectionRequest description: QuoteConnectionId required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.QuoteConnection' text/json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.QuoteConnection' application/xml: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.QuoteConnection' text/xml: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.QuoteConnection' application/json-patch+json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.QuoteConnection' application/merge-patch+json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.QuoteConnection' security: - SuperOffice_Password: [] SuperId_Authentication: [] components: schemas: SuperOffice.WebApi.v1.Carriers.QuoteCarriers.GetConnectionRequest: description: 'GetConnection: Returns the specified connection.' type: object properties: QuoteConnectionId: format: int32 type: integer SuperOffice.CRM.Services.QuoteConnection: description: "Information about a connection to the ERP system.\r\n\r\nCarrier object for QuoteConnection.\r\nServices for the QuoteConnection Carrier is available from the Quote Agent." type: object properties: QuoteConnectionId: format: int32 description: Primary key type: integer ERPName: description: Name of the ERP system (programmatic). type: string DisplayName: description: >- Connection name shown to user; multi-language support. The name of the connector to display in a list so that the users can choose between them. Typically the name of the client, with maybe the ERP system in parenthesis. type: string DisplayDescription: description: >- Tooltip/description shown to user; multi-language support. Any other info available that would make an uncertain user chose the right connector. Typically, used for tooltip. type: string Rank: format: int32 description: Rank order type: integer ConnectorName: description: >- Programmatic name of the Connector plugin that implements this kind of connection type: string ErpConnectionId: format: int32 description: The ERP Connection that this Quote connection is an extension of type: integer ExtraData: description: >- Optional extra data, in XML format, for configuring the connector. Connector-specific! type: string IsAvailable: description: >- Whether or not the specified connection is available. Typically, without network access the availability is false. type: boolean InitializeResponse: $ref: '#/components/schemas/SuperOffice.CRM.Services.PluginResponse' PriceLists: description: The PriceLists that this connection offers. type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.PriceList' AllAccess: description: >- Is this connection accessible to everyone? If not, then the QuoteConnectionAccess table tells us who can access it. type: boolean Deleted: description: >- If set, then this is a row that has been 'deleted'; we do not physically delete rows to avoid disaster. type: boolean UserGroupAccessIds: description: >- Array of ids containing usergroups that will have access to this connection. type: array items: format: int32 type: integer AssociateAccessIds: description: >- Array of ids containing associates that will have access to this connection. type: array items: format: int32 type: integer TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.PluginResponse: description: "PluginResponse exists to be able to respond with more than just a true/false, but also an explanation. Such an explanation can be displayed on for instance a disabled “Place Order” button.\r\n\r\nCarrier object for PluginResponse.\r\nServices for the PluginResponse Carrier is available from the Quote Agent." type: object properties: IsOk: description: >- Answer to the question / An indication if the operation went well. Equivalent to Status != Error type: boolean UserExplanation: description: >- A localized explanation to the answer. Text here is displayed to the user. type: string TechExplanation: description: Always in English type: string ErrorCode: description: An error code, if available. type: string Changes: $ref: '#/components/schemas/SuperOffice.CRM.Services.ChangedData' Status: description: >- QuoteStatus = Ok / OkWithInfo / Warn / Error. Error implies IsOk = false. enum: - Ok - OkWithInfo - Warning - Error type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.PriceList: description: "A pricelist is basically a collection of products. It can be valid in a time period, and outright deactivated. All prices in the product list is in a specific currency. We have decieded not to separate prices and products, which means that we get a simpler data model, but some redundancy.\r\n\r\nCarrier object for PriceList.\r\nServices for the PriceList Carrier is available from the Quote Agent." type: object properties: PriceListId: format: int32 description: Primary key type: integer ERPPriceListKey: description: The key that uniquely identifies this pricelist in the ERP system type: string QuoteConnectionId: format: int32 description: >- (Reserved for future use) The connection to the ERP system used for this pricelist type: integer Name: description: Name of this pricelist to use in the user interface. type: string Description: description: >- Description of this pricelist , will be used as tool-tip in the user interface. type: string Currency: description: The iso currency code, like 'USD' or 'NOK'. type: string CurrencyName: description: >- The name to use in the user interface, like perhaps 'US dollar' or '$' type: string ValidFrom: format: date-time description: >- The date (inclusive) the pricelist start to be valid. This can be DateTime.MinValue to signal that it doesn't have a specific start date. type: string ValidTo: format: date-time description: >- The date (inclusive) the pricelist ends to be valid. This can be DateTime.MaxValue to signal that it doesn't have a specific end date. type: string IsActive: description: >- Is the list active (as opposed to being worked on, suddenly canceled, etc. type: boolean TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Security.TableRight: description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted." type: object properties: Mask: type: string Reason: type: string SuperOffice.CRM.Security.FieldProperty: description: >- Class holding properties like field length, field type about a field in the carrier. type: object properties: FieldRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight' FieldType: type: string FieldLength: format: int32 description: '' type: integer SuperOffice.CRM.Services.ChangedData: description: "Generic carrier, used in return values to indicate what data NetServer has changed 'behind the scenes' so clients can know what to update\r\n\r\nCarrier object for ChangedData.\r\nServices for the ChangedData Carrier is available from the Quote Agent." type: object properties: AddedRecords: description: Ids of added records. type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.ChangedDataItem' UpdatedRecords: description: Ids of updated records. type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.ChangedDataItem' DeletedRecords: description: Ids of deleted records. type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.ChangedDataItem' TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Security.FieldRight: description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined." type: object properties: Mask: type: string Reason: type: string SuperOffice.CRM.Services.ChangedDataItem: description: "Tablename/recordid pair used to refer to records\r\n\r\nCarrier object for ChangedDataItem.\r\nServices for the ChangedDataItem Carrier is available from the Quote Agent." type: object properties: Tablename: description: Name of table, standardized to lowercase type: string RecordId: format: int32 description: Id of record, should never be 0 type: integer TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' ```` ## Related topics - [Get Connection](/en/api/reference/restful/agent/erpsync_agent/get-connection.md) - [Get Connections For Associate](/en/api/reference/restful/agent/quote_agent/get-connections-for-associate.md) - [Get Connection Startup Response](/en/api/reference/restful/agent/quote_agent/get-connection-startup-response.md) - [Get Connection Config Fields](/en/api/reference/restful/agent/quote_agent/get-connection-config-fields.md) - [Get Connection Startup Errors](/en/api/reference/restful/agent/quote_agent/get-connection-startup-errors.md) - [Get Connections And Display Fields](/en/api/reference/restful/agent/erpsync_agent/get-connections-and-display-fields.md)