> ## 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 Connections And Display Fields > Get all connection statuses and fields for a given entity NsApiSlow threshold: 5000 ms. ## Online Restricted: ## The ErpSync agent is not available in Online by default. Access must be requested specifically when app is registered. Intended for ERP integration apps. ## OpenAPI ````yaml /openapi/agent/openapi-v3-ErpSyncAgent.json post /api/v1/Agents/ErpSync/GetConnectionsAndDisplayFields openapi: 3.0.0 info: version: v1-Agents title: SuperOffice Agent API v1 description: SuperOffice Agent API - ErpSyncAgent 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/ErpSync/GetConnectionsAndDisplayFields: post: tags: - ErpSync_Agent summary: Get Connections And Display Fields description: "Get all connection statuses and fields for a given entity\n\nNsApiSlow threshold: 5000 ms.\r\n## Online Restricted: ## The ErpSync agent is not available in Online by default. Access must be requested specifically when app is registered. Intended for ERP integration apps." operationId: v1ErpSyncAgent_GetConnectionsAndDisplayFields 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.ErpSyncCarriers.GetConnectionsAndDisplayFieldsRequest text/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.ErpSyncCarriers.GetConnectionsAndDisplayFieldsRequest application/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.ErpSyncCarriers.GetConnectionsAndDisplayFieldsRequest text/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.ErpSyncCarriers.GetConnectionsAndDisplayFieldsRequest application/x-www-form-urlencoded: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.ErpSyncCarriers.GetConnectionsAndDisplayFieldsRequest application/json-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.ErpSyncCarriers.GetConnectionsAndDisplayFieldsRequest application/merge-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.ErpSyncCarriers.GetConnectionsAndDisplayFieldsRequest description: CrmActorType, EntityId required: true responses: '200': description: OK content: application/json: schema: type: array items: $ref: >- #/components/schemas/SuperOffice.CRM.Services.ErpConnectionData text/json: schema: type: array items: $ref: >- #/components/schemas/SuperOffice.CRM.Services.ErpConnectionData application/xml: schema: type: array items: $ref: >- #/components/schemas/SuperOffice.CRM.Services.ErpConnectionData text/xml: schema: type: array items: $ref: >- #/components/schemas/SuperOffice.CRM.Services.ErpConnectionData application/json-patch+json: schema: type: array items: $ref: >- #/components/schemas/SuperOffice.CRM.Services.ErpConnectionData application/merge-patch+json: schema: type: array items: $ref: >- #/components/schemas/SuperOffice.CRM.Services.ErpConnectionData security: - SuperOffice_Password: [] SuperId_Authentication: [] components: schemas: SuperOffice.WebApi.v1.Carriers.ErpSyncCarriers.GetConnectionsAndDisplayFieldsRequest: description: >- GetConnectionsAndDisplayFields: Get all connection statuses and fields for a given entity type: object properties: CrmActorType: enum: - Unknown - Contact - Person - Project - Sale type: string EntityId: format: int32 type: integer SuperOffice.CRM.Services.ErpConnectionData: description: "Contains connection data and field labels for one connection\r\n\r\nCarrier object for ErpConnectionData.\r\nServices for the ErpConnectionData Carrier is available from the ErpSync Agent." type: object properties: ErpConnectionId: format: int32 description: The id of the connection type: integer ConnectionName: description: The name of the connection type: string Connected: description: True if this entity instance has syncronized connection type: boolean ErpFields: description: The ERP fields that should be displayed type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.FieldMetadata' CrmActorType: description: The crm actor type which these fields belongs to enum: - Unknown - Contact - Person - Project - Sale type: string ErpActorType: description: The erp actor type which these fields belongs to enum: - Unknown - Customer - Supplier - Partner - Person - Project - Employee - Sale type: string ErpActorTypes: description: Contains all mapped ErpActorType for this CrmActorType type: array items: enum: - Unknown - Customer - Supplier - Partner - Person - Project - Employee - Sale 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.FieldMetadata: description: "This is used to populate the Admin configuration dialog for a connection. The call to the ERP Connector’s GetConfigurationFields method returns a list of fields and field types. The Admin client builds a dialog with these fields\r\n\r\nCarrier object for FieldMetadata.\r\nServices for the FieldMetadata Carrier is available from the Quote Agent." type: object properties: FieldKey: description: >- Internal key/name of the field. Used as the key in the ConnectionConfigField values when TestConnection is called. type: string Rank: format: int32 description: >- A way to set the order of the fields. Lowest value will be displayed first/over the fields with other values. type: integer DisplayName: description: Localized field name – shown in the GUI type: string DisplayDescription: description: Tooltip for the field name. type: string FieldType: description: String, int, decimal, etc. enum: - Checkbox - Text - Password - Integer - Double - List - Date - Label type: string ListName: description: MDO List provider name for list fields type: string DefaultValue: description: A default value for the field. type: string MaxLength: format: int32 description: >- Maximum length for strings, if set. 0 means no restriction. (Though sooner or later something will no doubt overflow if you pile on the gigabytes.) type: integer Access: description: Access restrictions on the field enum: - Normal - Mandatory - ReadOnly type: string ShowInSearch: description: True if this field is displayed in search result 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.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 ```` ## Related topics - [SuperOffice.WebApi.Data.ErpSync GetConnectionsAndDisplayFieldsRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.ErpSync_GetConnectionsAndDisplayFieldsRequest.md) - [SuperOffice.WebApi.Agents.IErpSyncAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IErpSyncAgent.md) - [Get Connection Config Fields](/en/api/reference/restful/agent/quote_agent/get-connection-config-fields.md) - [Get Erp Connection Config Fields](/en/api/reference/restful/agent/erpsync_agent/get-erp-connection-config-fields.md) - [Get Connection](/en/api/reference/restful/agent/erpsync_agent/get-connection.md) - [Get All Connections](/en/api/reference/restful/agent/erpsync_agent/get-all-connections.md)