contacts

List Contact Lists

Changed on

List the contact lists in the workspace.

Requires the contact_lists:read scope on the API key.

get/v1/contact-lists

Request

  • Base URL: https://api.topo.io
  • URL: https://api.topo.io/v1/contact-lists
  • Auth: HTTP bearer

Query parameters

pageinteger

Page number.

sizeinteger

Number of items per page.

sort_by'created_at' | 'updated_at' | 'name'

Field to sort by.

sort_order'asc' | 'desc'

Sort direction.

namestring nullable

Filter by list name (exact match).

created_at_beforestring date-time nullable

Return lists created strictly before this timestamp.

created_at_afterstring date-time nullable

Return lists created strictly after this timestamp.

Response

Successful Response

total_countinteger required

Total number of records matching the query.

total_pagesinteger required

Total number of pages.

has_moreboolean required

Whether more pages remain after the current one.

Changes

  • 467ce2bf692bRevision changes
    • info

      added the optional property // to the response with the status