Skip to main content
GET
List Contacts

Authorizations

x-api-key
string
header
required

Your Meow API key, sent in the x-api-key header for authentication.

Headers

x-entity-id
string<uuid>

Optional entity_id to scope requests to a specific entity.

Query Parameters

nickname_query
string | null

Optional filter to search contacts by nickname.

limit
integer
default:10

Maximum number of results to return.

Required range: 1 <= x <= 100
offset
string | null

Opaque offset identifier for pagination. Use the nextOffset from a previous response.

Maximum string length: 100

Response

Successful Response

contacts
CustomerApiContact · object[]
required

List of contacts.

page
PageMetadata · object | null

Pagination metadata.