Deprecated; use GET /v2/recipients.

get/v2/contacts

Request

  • Base URL
    https://api.slash.com
  • URL
    https://api.slash.com/v2/contacts
  • 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' | 'lastPaidAt'

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
  • lastPaidAt — the most recent payment to the recipient, with recipients that have never been paid last; descending
sortDirection'asc' | 'desc'

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

recipientType'contact' | 'vendor'

Return only people or only vendors.

includeArchivedboolean

Include archived contacts. Defaults to false.

Response

A page of contacts.

Changes