Skip to main content
GET
Get a buyer by ID

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
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[]