Skip to main content
GET
/
v0
/
externalReferences
List
curl --request GET \
  --url https://api.paygentic.io/v0/externalReferences \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "object": "externalReference",
      "merchantId": "<string>",
      "entityType": "item",
      "entityId": "<string>",
      "provider": "<string>",
      "externalId": "<string>",
      "metadata": {},
      "isPrimary": true,
      "isDefault": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "externalLabel": "<string>"
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

Authorizations

​
Authorization
string
header
required

API key authentication

Query Parameters

​
merchantId
string

Restrict results to a specific merchant. All active filters AND together.

Pattern: ^org_[a-zA-Z0-9]+$
​
entityType
enum<string>

Filter by the Paygentic entity type the reference points at (e.g. item). All active filters AND together. The type of Paygentic entity this external reference points at

Available options:
item
​
entityId
string

Filter by the Paygentic entity id (e.g. itm_xxx). This is the inverse of the GET /v0/items?provider=&externalId= resolution endpoint — look up references from the Paygentic side. All active filters AND together.

​
provider
string

Filter by provider (e.g. salesforce, netsuite). All active filters AND together. Lowercase snake_case provider identifier (e.g. salesforce, netsuite)

Maximum string length: 64
Pattern: ^[a-z][a-z0-9_]*$
​
externalId
string

Filter by the external system's record id. Pair with provider to look up all Paygentic entities that carry a given external reference. All active filters AND together. Identifier of the record in the external system

Maximum string length: 255
Pattern: ^[a-zA-Z0-9_-]+$
​
limit
integer
default:50
Required range: 1 <= x <= 100
​
offset
integer
default:0
Required range: x >= 0

Response

List of external references

​
data
object[]
required
​
pagination
object
required

Offset-based pagination response.