Contacts

List contacts

List contacts in the workspace. Use expand to include accessible documents or transactions.

get/contacts

Request

Base URL: https://next-api.saturation.io/v1
URL: https://next-api.saturation.io/v1/contacts
Auth: HTTP bearer

Query parameters

limitinteger

Maximum number of items to return on a page. Capped at 100.

cursorstring

Cursor from the previous page's nextCursor. Use it with the same filters and sort.

sortstring

Field to sort by. Allowed fields depend on the resource.

order'asc' | 'desc'

Sort direction.

expandContactExpand[]

Comma list of related data to inline on contacts (depth ≤ 2). Unknown key returns 400 expand_invalid.

withCountboolean

Include the total number of matching items. Defaults to false.

qstring

Search contact names, companies, and email addresses.

typestring

Example:contractor

Filter by one or more comma-separated contact types.

tagsstring

Comma-separated tag handles to filter by.

tagMode'any' | 'all' | 'none'

How tags combine.

track1099boolean

Filter by 1099 tracking status.

hasTaxIdboolean

Filter by whether a tax ID is on file.

includeDeletedboolean

Include deleted contacts.

Response

A page of contacts.

nextCursorstring nullable

Cursor for the next page. Pass it as cursor with the same filters and sort. Null on the last page.

countinteger

Total matching items; present only when withCount=true was requested.

truncatedboolean

Whether some matching items were omitted from the response.

Example response

{
  "data": [
    {
      "id": "txn_8f2a1c9e",
      "displayName": "Aerial Imaging LLC",
      "rate": {
        "amount": 152900,
        "currency": "USD"
      },
      "documents": [
        {
          "id": "txn_8f2a1c9e"
        }
      ],
      "transactions": [
        {
          "id": "txn_8f2a1c9e",
          "projectId": "txn_8f2a1c9e",
          "budgetLineId": "txn_8f2a1c9e"
        }
      ]
    }
  ],
  "nextCursor": "eyJpZCI6InR4bl84ZjJhMWM5ZSJ9"
}

Changes

Changes to this operation have not been checked yet.