CRM Record

POST

/api/v1/workspaces/{workspaceId}/crm/{objectSlug}/records/search

Scope crm:read

Search CRM records with optional property filters and sorting. Results are paged.

Pfad

workspaceIdPflicht

string (uuid)

Workspace that owns the resource.

objectSlugPflicht

string

CRM object slug, for example contact.

Request

application/json · CrmSearchRequestDto

page

integer (int32)

Page number, starting at 1.

pageSize

integer (int32)

Number of items per page.

filters

CrmFilterDto[]

Filters.

sort

CrmSortDto

fields

string[]

Fields.

Antworten

200CrmObjectRecordLightDtoThe request succeeded. The JSON body contains url, data, and meta. The linked schema is data.

CRM object record light.

string (uuid)

Identifier.

objectSlugPflicht

string

Object slug.

createdAt

string (date-time)

When this was created.

updatedAt

string (date-time)

When this was last updated.

archivedAt

string (date-time)

When the archived was recorded.

ownerUserId

string (uuid)

Identifier of the owner user.

values

object

400ApiProblemThe request is invalid.

401ApiProblemThe private app token is missing or invalid.

403ApiProblemThe token is missing the required scope, or this action is not allowed.

404ApiProblemThe workspace or resource was not found.

defaultApiProblemError response.