Skip to main content
GET
List records

Authorizations

x-conveyour-token
string
header
required

Your API key token. Contacts endpoints require a Server-only — Full API key — see Authentication.

Query Parameters

obj_id
string

Filter records by Custom Object type ID. Recommended to always pass this to scope results to the right object type.

obj_name
string

Alternative to obj_id — filter by object type name/slug.

Text search across record fields.

sort
object

Sort spec: { "field_name": 1 } for ascending, { "field_name": -1 } for descending. Pass plain field_name for custom data fields — the API adds the d. prefix automatically. Passing d.field_name will double-prefix the path. System fields (created_at, updated_at, external_id, etc.) are passed as-is.

page
integer

Page number (1-based). When omitted or 0, returns a flat array with no pagination. When set to 1 or higher, returns paginated results. Default: 0 (no pagination).

per_page
integer

Records per page when pagination is enabled (page ≥ 1). Default: 100.

format
string

Pass csv to download results as a CSV file instead of JSON.

teams[]
string[]

Team scope for the request, as one or more team ObjectIds. The brackets are required: PHP keeps only the last value for a repeated plain key, so teams=A&teams=B silently resolves to B alone. On requests with a JSON body you may send teams (no brackets) in the body instead.

Values that are not valid ObjectIds are silently ignored — a mistyped team ID behaves as if no team was sent. See the teams section of the API conventions guide.

Response

Success.

The common response envelope shared by all ConveYour endpoints.

status
enum<string>

ok on success, failed on error.

Available options:
ok,
failed
message
string

Human-readable description of the result.

data
object

The response payload — an object or an array depending on the endpoint.