List Contacts by IDs

get

https://api.sandbox.layer1.com/platform/v1/contacts

Bulk-fetch Contacts by a list of IDs. Useful when you cache Contact IDs locally and need to reconcile against the BEEM source of truth.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

Lucene-style query for filtering contacts. Supported fields: searchTerm (free text search, e.g., searchTerm:John), entityType (INDIVIDUAL, COMPANY, e.g., entityType:COMPANY), relationshipType (SELF_OWNED, THIRD_PARTY).

totalCountLimit

int32

≥ 1

Maximum rows to count for pagination. When the result set exceeds this value, the total count will be capped at this number (use to optimize performance for large datasets).

pageNumber

integer

≥ 0

Defaults to 0

Zero-based page index (0..N)

pageSize

integer

≥ 1

Defaults to 20

The size of the page to be returned

sort

array of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

sort

ids

array of uuids

required

List of contact IDs

ids*

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

*/*

200Contacts retrieved successfully

400Invalid request

401Unauthorized

403Forbidden

404Not Found

409Conflict

428Precondition Required