v1

latestOpenAPI 3.0.12026-07-2412502.6 MB
Customers

Get a customer

Get customer by id

get/customers/{customer_id}

Query parameters

with'customer_cards' | 'customer_addresses'

Expand on the information returned by including 'with' in the query parameters. For multiple attributes, separate with a comma (example : with=customer_cards,customer_addresses)

Response

OK

customer_idinteger
connection_customer_idstring nullable
connection_idinteger
first_namestring
last_namestring
emailstring
ip_addressstring
phonestring
birthdaystring date nullable
genderstring
pronoun_idnull | 1 | 2 | 3 | 4 nullable
  • 1 - he/him
  • 2 - she/her
  • 3 - they/them
  • 4 - rather not say
active_subscriberboolean
is_blacklistboolean
is_fraudboolean
date_createdstring date-time
date_modifiedstring date-time
created_byinteger
modified_byinteger
customer_notesstring nullable
tracking1string nullable
tracking2string nullable
tracking3string nullable
tracking4string nullable
tracking5string nullable
tracking6string nullable
tracking7string nullable
tracking8string nullable
tracking9string nullable
tracking10string nullable
tracking11string nullable
tracking12string nullable
tracking13string nullable
tracking14string nullable
tracking15string nullable
tracking16string nullable
tracking17string nullable
tracking18string nullable
tracking19string nullable
tracking20string nullable

Example response

{
  "date_created": "2023-04-01 00:00:00",
  "date_modified": "2023-04-01 00:00:00",
  "customer_cards": [
    {
      "date_created": "2023-04-01 00:00:00",
      "date_modified": "2023-04-01 00:00:00"
    }
  ],
  "customer_addresses": [
    {
      "date_created": "2023-04-01 00:00:00",
      "date_modified": "2023-04-01 00:00:00"
    }
  ]
}