Skip to main content
GET
/
api
/
v1
/
buyers
/
{id}
Get a buyer by ID
curl --request GET \
  --url https://integrations.polinate.ai/api/v1/buyers/{id} \
  --header 'X-API-Key: <x-api-key>' \
  --header 'X-Business-Id: <x-business-id>'
{
  "id": "phm_123",
  "name": "Acme Pty Ltd",
  "legalName": "Acme Pty Ltd",
  "primaryEmail": "[email protected]",
  "primaryPhone": "+61 2 9000 0000",
  "status": "ACTIVE",
  "partnershipId": "prt_456",
  "partnershipStatus": "ACTIVE",
  "itemListId": "list_789",
  "buyerInfo": {
    "notes": "Key account"
  },
  "emails": [
    {
      "id": "eml_1",
      "email": "[email protected]",
      "contactName": "Orders",
      "isPrimary": true
    }
  ],
  "phones": [
    {
      "id": "phn_1",
      "phone": "+61 400 000 001",
      "contactName": "Warehouse",
      "isPrimary": false
    }
  ],
  "locations": [
    {
      "id": "loc_1",
      "label": "Sydney DC",
      "type": "WAREHOUSE",
      "status": "ACTIVE",
      "addressLine1": "1 George St",
      "city": "Sydney",
      "state": "NSW",
      "postcode": "2000",
      "country": "AU"
    }
  ]
}

Headers

​
X-Business-Id
string
required

Business identifier for external auth. Find in Polinate app → Business Settings → Integrations.

Example:

"{{businessId}}"

​
X-API-Key
string
required

Per-business API key for external auth. Find in Polinate app → Business Settings → Integrations.

Example:

"{{apiKey}}"

Path Parameters

​
id
string
required
Example:

"phm_123"

Response

OK

​
id
string
required
​
name
string
required
​
legalName
string
required
​
partnershipId
string
required
​
partnershipStatus
enum<string>
required
Available options:
PENDING,
ACTIVE,
PAUSED,
TERMINATED,
DECLINED,
EXPIRED
​
itemListId
string | null
required
​
primaryEmail
string | null
​
primaryPhone
string | null
​
status
string
​
createdAt
string
​
updatedAt
string
​
deletedAt
string | null
​
properties
object
​
buyerInfo
object
​
emails
object[]
​
phones
object[]
​
locations
object[]