List Customer

Lists all (or one) customers.

Endpoint URL

https://{{base_url}}/api/v2/customer

Authentication and rate limits

Authentication methodOAuth 2.0 Bearer token
Rate limitRate Limit

Requests Example

curl --request GET \
  --url 'https://{{base_url}}/api/v2/customer/?company=1' \
  --header 'Authorization: Bearer $BEARER_TOKEN'

Query Parameters

  • company (integer) --

    [REQUIRED]
    The ID of the specific company your API is calling. For accounts with only one company, the default value is 1.
    To lookup a specific company ID, see the List Company API.

  • id (integer) --

    Optional if you want to list a specific customer ID. The id parameter is passed as part of the request url /customer/$id/.

Language
Click Try It! to start a request and see the response here!