Get a customer

GET

/v1/customers/{id}

Returns a single customer profile, honouring ?fields= selection.

Authorizations

BearerAuth

API key in the form one_pk_<random>. Mint at /settings/api-keys.

Type

HTTP (bearer)

Parameters

Path Parameters

id*

The customer-profile id (uuid).

Type

string

Required

Example"123"

Query Parameters

fields

Comma-separated sparse fieldset. See list endpoint.

Type

string

Responses

Successful response

Content-Type

application/json

{

  

"meta": {

  

  

"version": 0

  

},

  

"data": {

  

  

"id": "string",

  

  

"party_id": "string",

  

  

"name": "string",

  

  

"status": "string",

  

  

"account_number": "string",

  

  

"payment_terms": "string",

  

  

"default_currency": "string",

  

  

"credit_limit": "string",

  

  

"billing_email": "string",

  

  

"contact_first_name": "string",

  

  

"contact_last_name": "string",

  

  

"contact_email": "string",

  

  

"contact_phone": "string",

  

  

"notes": "string",

  

  

"custom_fields": {

  

  

  

"additionalProperties": null

  

  

},

  

  

"created_at": "string",

  

  

"updated_at": "string"

  

}

}

GET

/v1/customers/{id}

Playground

Server

Authorization

BearerAuth

Variables

Key

Value

id*

fields

Samples

Powered by VitePress OpenAPI