appConnectorLink

Requires at least one of the permissions customers:customer:read, inventory:stock_level:read, inventory:warehouse:read, payments:payment:read, products:product:read, purchase:grn:read, purchase:purchase_invoice:read, purchase:purchase_order:read, sales:credit_note:read, sales:quote:read, sales:sales_invoice:read, sales:sales_order:read, sales:shipment:read or suppliers:supplier:read.

The calling app's link for one record, found by its ARC id or its external id. Needs write_connector_sync.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query AppConnectorLink($resource: String!) {
  appConnectorLink(resource: $resource) {
    arcId
    externalId
    externalVersion
    lastSyncedAt
    resource
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query AppConnectorLink($resource: String!) {\n  appConnectorLink(resource: $resource) {\n    arcId\n    externalId\n    externalVersion\n    lastSyncedAt\n    resource\n  }\n}",
  "variables": {
    "resource": "string"
  }
}
EOF

Variables:

{
  "resource": "string"
}

Response:

{
  "data": {
    "appConnectorLink": {
      "arcId": "id",
      "externalId": "string",
      "externalVersion": "string",
      "lastSyncedAt": "2025-01-15T00:00:00Z",
      "resource": "string"
    }
  }
}

appConnectorLink(
  arcId: ID
  externalId: String
  resource: String!
): ConnectorLinkView

Arguments

appConnectorLink.arcId ● ID scalar

The ARC record's id.

appConnectorLink.externalId ● String scalar

The record's id in the app's system.

appConnectorLink.resource ● String! non-null scalar

What kind of record, e.g. invoice.

Type

ConnectorLinkView object

One ARC record linked to its record in a connected system, for one installed app.