Get all customers

GET /customers

Query parameters

  • limit integer

    The maximum number of customer accounts to be returned. Defaults to 12.

    Minimum value is 0, maximum value is 10000.

  • starting_after string

    Pass the value from the paging response body in your previous request. If not provided, the zero-indexed starting point will be used. Either starting_after or ending_before may be provided, but not both.

  • ending_before string

    Pass the value from the paging response body in your previous request. If not provided, the zero-indexed starting point will be used. Either starting_after or ending_before may be provided, but not both.

  • is_active string

    Comma-separated list of active statuses of the customer to filter by (no whitespaces).
    Allowed values: true, false

  • product_type string

    Comma-separated list of the product types of the accounts to filter by (no whitespaces).
    Allowed values: INSTALLMENT, INVENTORY_FINANCING, REVOLVING, LOGISTICS_FINANCING, etc.

  • search_parameters string

    Searches by name_first, name_last, doing_business_as or business_legal_name. Based on the input search parameter, the top responses from our API search, up to or less than the provided limit will be returned.

Responses

  • • 200 object

    Array of Customers and their corresponding Accounts

    • An array of information for all customers within the requested range.

    • paging object

      Pagination Information.

      • starting_after string

        Use this to drive your next request if you want the next page of results

      • ending_before string

        Use this to drive your next request if you want the previous page of results

      • has_more boolean

        Indicates whether there are additional values beyond the ending index of the paginated results.

  • • 401

    Unauthorized.

  • • 403

    Forbidden.

  • • 429

    Too many requests.

  • • default

    Unexpected Error.

GET /customers 
curl \
 -X GET https://<your_environment_name>-uat-api.canopyservicing.com/customers \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response example (200) 
{
  "": [
    [
      {}
    ]
  ],
  "paging": {
    "starting_after": "31mNprzLd2bKl6koVna68ARM",
    "ending_before": "31mNprzLd2bKl6koVna68ARM",
    "has_more": false
  }
}