SLslashfi

List customers

Changed on

List the customers you invoice. See Customers.

get/v2/customers

Request

  • Base URL
    https://api.slash.com
  • URL
    https://api.slash.com/v2/customers
  • Auth
    API key in header X-API-Key

Query parameters

cursorstring

The opaque metadata.nextCursor value from the previous page. It carries that page's filters, page size and ordering, so pass it on its own; see Pagination.

limitinteger

Number of items per page, from 1 to 100. The page size is carried inside metadata.nextCursor, so later pages keep the same size unless limit is passed again to change it.

sort'createdAt' | 'name'

Field to order the page by. Each value has its own default direction, used unless sortDirection is passed. See Sorting.

  • createdAt (default) — descending
  • name — ascending
sortDirection'asc' | 'desc'

Direction of the ordering selected by sort. When omitted, each sort value uses its own default; see Sorting.

status'active' | 'archived'

Return only customers in this status.

searchstring

Match customers by name, email or id.

Response

A page of customers.

Example response

{
  "items": [
    {
      "id": "le_cus_2rj4l7hmrrrcv",
      "name": "Acme Robotics",
      "email": "ap@acme.example",
      "phone": "+14155550123"
    }
  ]
}

Changes