Skip to main content
GET
/
v0
/
items
List
curl --request GET \
  --url https://api.paygentic.io/v0/items \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "object": "item",
      "merchantId": "<string>",
      "name": "<string>",
      "metadata": {},
      "externalReferences": [
        {
          "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>"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

Authorizations

​
Authorization
string
header
required

API key authentication

Query Parameters

​
merchantId
string

Filter items by merchant organization id

Pattern: ^org_[a-zA-Z0-9]+$
​
provider
string

Provider whose external code to resolve (e.g. salesforce, netsuite). Must be supplied together with externalId.

​
externalId
string

Resolve every live Item mapped to this (provider, externalId) — the canonical primary plus any non-primary aliases. The primary Item is returned first and is identifiable by its matching reference's isPrimary: true. Empty list on no match. Must be supplied together with provider.

​
limit
integer
default:50

Maximum items to return. In resolution mode (provider+externalId supplied) pagination is over the de-duplicated resolved Item set, primary Item first.

Required range: 1 <= x <= 100
​
offset
integer
default:0

Zero-based offset for pagination. In resolution mode this paginates the de-duplicated resolved Item set.

Required range: x >= 0

Response

List of items

​
data
object[]
required
​
pagination
object
required

Offset-based pagination response.