GET /customers/{id}.json

Path parameters

id integer(int64) Required

Numeric ID of the instance

Minimum value is 1.

Responses

200 application/json

Successful response
Hide response attributes Show response attributes object
- accountsEmail string | null
  
  Accounts email
- companyCode string | null
  
  Company code
  
  Maximum length is 30.
- createdAt string(date-time)
  
  Created at
- email string Required
  
  Email
- fax string | null
  
  Fax
  
  Maximum length is 30.
- firstName string | null
  
  First name
- id integer(int32)
  
  Id
- lastName string | null
  
  Last name
- name string | null
  
  Name
- notes string | null
  
  Notes
- orderEmail string | null
  
  Order email
- phone string | null
  
  Phone
  
  Maximum length is 30.
- priceListId integer(int32) | null
  
  Price list
- quickbooksId string | null
  
  Quickbooks
- resellerId integer(int32) | null
  
  Reseller
- returnsEmail string | null
  
  Returns email
- saleNotes string | null
  
  Sale notes
- status string | null Required
  
  Status
  
  Values are active or disabled. Default value is active.
- stripeId string | null
  
  Stripe
- tags array[string] | null
  
  Tags
- taxNumber string | null
  
  Tax number
  
  Maximum length is 30.
- token string | null
  
  Token
- updatedAt string(date-time)
  
  Updated at
- userId integer(int32) | null
  
  User
- xeroId string | null
  
  Xero

curl \
 --request GET 'http://api.example.com/v1/customers/{id}.json' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "accountsEmail": "string",
  "companyCode": "string",
  "createdAt": "2025-05-04T09:42:00Z",
  "email": "string",
  "fax": "string",
  "firstName": "string",
  "id": 42,
  "lastName": "string",
  "name": "string",
  "notes": "string",
  "orderEmail": "string",
  "phone": "string",
  "priceListId": 42,
  "quickbooksId": "string",
  "resellerId": 42,
  "returnsEmail": "string",
  "saleNotes": "string",
  "status": "active",
  "stripeId": "string",
  "tags": [
    "string"
  ],
  "taxNumber": "string",
  "token": "string",
  "updatedAt": "2025-05-04T09:42:00Z",
  "userId": 42,
  "xeroId": "string"
}