query contacts
GET https://api.suger.cloud/org/{orgId}/contact/query
Query contacts with filtering, sorting, and pagination using CRUD query language. Supports complex filters, sorting by multiple fields, and pagination.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
orgId | path | string | yes | Organization ID |
page_size | query | integer | no | Number of items per page (default 20, max 1000) |
page_number | query | integer | no | Page number (default 1) |
qs | query | string | no | Query style: 'json' or 'lisp' (default 'lisp') |
q | query | string | no | Filter expression in the format specified by qs param |
ss | query | string | no | Sort style: 'json' or 'simple' (default 'simple') |
s | query | string | no | Sort expression in the format specified by ss param |
Responses
200 — Paginated list of contacts
Content-Type: application/json · Schema: crud.ListBaseResponse-orm_IdentityContact
400 — Bad request error
Content-Type: application/json
500 — Internal server error
Content-Type: application/json