Skip to content
Pinlyx Docs
Open app

List contacts

GET
/v1/contacts

Returns a cursor-paginated list of contacts in the active workspace. Pass after=<id> to fetch the next page. For a full initial sync use order=asc and walk forward from after=0; for an incremental sync add updatedSince. Requires scope contacts:read.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters ”
X-Workspace-Id
integer

Act on this workspace’s shared CRM pool. Membership is verified on every request, so an id you do not belong to falls back to personal scope rather than widening access. Omit it to use your default workspace. Applies to every CRM endpoint, not only the ones that list it here.

Query Parameters

Section titled “Query Parameters ”
after
integer

Return contacts on the far side of this id (less than, or greater than when order=asc).

limit
integer
default: 25 >= 1 <= 100

Number of contacts to return. Clamped to 1-100.

platform
string
Allowed values: telegram twitter

Filter by platform.

q
string

Case-insensitive substring search across name, username, phone, email, company and externalId.

externalId
string

Exact match on the contact’s id in your own system.

email
string

Exact, case-insensitive match on the email address.

updatedSince
string format: date-time

Only contacts changed at or after this UTC timestamp. The cheap way to run an incremental sync.

includeInactive
boolean

Include contacts that were soft-deleted (archived). Off by default.

order
string
default: desc
Allowed values: desc asc

Sort direction by id. desc (newest first) is the default; asc gives a stable oldest-first walk for a full sync.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Paginated contact list.

Cursor-paginated list of contacts.

object
items
Array<object>

A CRM contact record.

object
id
integer
platform

Social platform the contact belongs to.

string
Allowed values: telegram twitter
name
string
nullable
username

Handle without the leading @.

string
nullable
phone
string
nullable
email
string
nullable
company
string
nullable
externalId

The contact’s id in your own system. The stable key the batch endpoint upserts on.

string
nullable <= 100 characters
country
string
nullable
city
string
nullable
notes
string
nullable
stage

CRM pipeline stage.

string
leadScore

Lead score 0-100 (higher = hotter). Null when not scored.

integer
nullable
leadScoreIsAi

True when the score was last set by AI, false for a manual override.

boolean
assignedToUserId

Team member the contact is assigned to.

integer
nullable
ownerUserId

Workspace member the row is filed under. Differs from the caller in a shared pool.

integer
nullable
pipelineId

Custom pipeline board the contact sits on.

integer
nullable
pipelineStageId

Column within pipelineId.

integer
nullable
source

How the contact entered the CRM (OutboundMessage, InboundMessage, Manual, CsvImport, Extension, …).

string
isArchived

True once the contact has been soft-deleted or archived.

boolean
createdAt
string format: date-time
updatedAt
string format: date-time
nullable
lastMessageAt
string format: date-time
nullable
hasUnreadMessages
boolean
customFields

Custom field values keyed by field key. Null when the contact has none.

object
tags

Attached tags (populated on GET by id, omitted in list responses).

Array<object>
nullable
object
id
integer
name
string
color

Hex color

string
nextCursor

Pass as after on the next request to continue pagination. Null when hasMore is false.

integer
nullable
hasMore

Whether additional pages exist beyond this response.

boolean
Example
{
  "items": [
    {
      "id": 101,
      "platform": "telegram",
      "name": "Acme Inc.",
      "username": "john_doe",
      "phone": null,
      "notes": null,
      "stage": "Lead",
      "createdAt": "2024-03-01T10:00:00Z",
      "lastMessageAt": null,
      "hasUnreadMessages": false
    }
  ],
  "nextCursor": 101,
  "hasMore": false
}

400

Section titled “400 ”

The request body or parameters failed validation.

Standard error envelope for all v1 error responses.

object
error

Machine-readable error code.

string
Allowed values: bad_request not_found conflict unauthorized forbidden payment_required provider_rejected rate_limited internal_error
message

Human-readable explanation of the error.

string
details

Optional structured context (field-level validation errors, etc.).

nullable
Example
{
  "error": "bad_request",
  "message": "at least one of name, username, phone is required"
}

401

Section titled “401 ”

Missing or invalid bearer token.

Standard error envelope for all v1 error responses.

object
error

Machine-readable error code.

string
Allowed values: bad_request not_found conflict unauthorized forbidden payment_required provider_rejected rate_limited internal_error
message

Human-readable explanation of the error.

string
details

Optional structured context (field-level validation errors, etc.).

nullable
Example
{
  "error": "unauthorized",
  "message": "Invalid bearer principal"
}

403

Section titled “403 ”

The API key does not have the required scope for this operation.

Standard error envelope for all v1 error responses.

object
error

Machine-readable error code.

string
Allowed values: bad_request not_found conflict unauthorized forbidden payment_required provider_rejected rate_limited internal_error
message

Human-readable explanation of the error.

string
details

Optional structured context (field-level validation errors, etc.).

nullable
Example
{
  "error": "forbidden",
  "message": "scope contacts:write is required"
}

429

Section titled “429 ”

Per-key rate limit exceeded. Retry after the time indicated by X-RateLimit-Reset.

Standard error envelope for all v1 error responses.

object
error

Machine-readable error code.

string
Allowed values: bad_request not_found conflict unauthorized forbidden payment_required provider_rejected rate_limited internal_error
message

Human-readable explanation of the error.

string
details

Optional structured context (field-level validation errors, etc.).

nullable
Example
{
  "error": "rate_limited",
  "message": "rate limit exceeded"
}

Headers

Section titled “Headers ”
X-RateLimit-Limit
integer

Maximum requests allowed per minute for this key.

X-RateLimit-Remaining
integer

Requests remaining in the current window.

X-RateLimit-Reset
integer

Unix timestamp (seconds) when the rate limit window resets.