v19

latestOpenAPI 3.1.1raw.githubusercontent.com2026-08-017489931.2 KB

List contacts

Returns a paginated list of contacts. Use offset and limit to paginate through results, and $field query parameters to filter. See <u>List endpoints</u> for more information about <u>pagination</u> and <u>filtering</u>.

Required scope: contacts:read

Rate limit category: Search

get/v1/contacts

Query parameters

offsetinteger

Number of records to skip for pagination. Defaults to 0.

limitinteger

Maximum number of records to return. Defaults to 25, maximum 25.

Headers

Lightfield-Version'2026-03-01' required

Required API version header. Requests may error without it.

Response

OK

objectstring required

The object type, always "list".

totalCountinteger required

Total number of entities matching the query.