Theme switcher

Customers

The Customers API allows partner applications to manage customer records in COUNT.Customers represent individuals or organizations that you bill, invoice, or transact with.

This API enables you to:

  • List customers associated with your team
  • Retrieve customer details using a UUID
  • Create and update customer records
  • Search for customers by email

All customer data is securely scoped to the authenticated team.


Authentication

All Customers API endpoints require both authentication mechanisms:

HMAC Authentication

Include the following headers in every request:

  • x-client-id
  • x-signature

OAuth Bearer Token

Include a valid access token obtained via the OAuth flow:

Authorization: Bearer YOUR_ACCESS_TOKEN

Requests missing either authentication method will be rejected.


Customer Identification

  • All customers are identified using UUIDs
  • Integer or internal IDs are not exposed to partner applications
  • UUIDs are returned in all customer-related responses and must be used in subsequent requests

Email Uniqueness

  • Customer email addresses must be unique within a team
  • Attempting to create a customer with an existing email will result in an error
  • Use the Find Customer by Email endpoint to check for existing customers before creation

Addresses

Customers can have both:

  • Billing Address
  • Shipping Address

Each address supports the following fields:

  • street
  • city
  • state
  • zipCode
  • country

Contacts

  • A customer may have multiple contacts
  • One contact can be marked as the primary contact
  • Contacts include name, email, phone number, and primary status

Available Endpoints

Use the endpoints below to manage customers:

  • List Customers – Retrieve all customers for your team
  • Get Customer – Retrieve a customer by UUID
  • Create Customer – Create a new customer record
  • Update Customer – Update an existing customer
  • Find Customer by Email – Search for a customer using an email address

Was this section helpful?

What made this section unhelpful for you?

Endpoints

GET
POST
GET
PUT
GET
Was this section helpful?

What made this section unhelpful for you?