Skip to main content
GET
List contacts

Authorizations

Authorization
string
header
required

Workspace API key created in Developer → API Keys.

Headers

X-Profile-Id
string<uuid>
required

The workspace profile performing the request. It must be attached to the API key.

Query Parameters

cursor
string
Minimum string length: 1
limit
integer
Required range: 1 <= x <= 50
query
string
Maximum string length: 100

Response

Agent Response Protocol success envelope.

Agent Response Protocol success envelope.

ok
enum<boolean>
required

Whether the API request completed successfully.

Available options:
true
data
object
required

Returns searchable contacts for the current profile or verified guest.

agent
object
required

Wircle-generated context for AI agents. This object may be empty.