# Filter all clients

Endpoint: GET /clients
Version: v1
Security: http

## Query parameters:

  - `sort` (string)
    Available sorts are name, shortcode, created_at.You can sort by multiple options by separating them with a comma. To sort in descending order, use - sign in front of the sort, for example: -title.
    Example: "sort=-created_at,title"

  - `include` (string)
    Available includes are primaryContact, projects, originSpace. You can include multiple options by separating them with a comma.

  - `page[size]` (integer)
    The number of results that will be returned per page.

  - `page[cursor]` (string)
    The cursor to start the pagination from.

  - `filter` (string)
    Allowed filter fields (with allowed operators):

| Field | Type | Operators |
|------|------|-----------|
| name | string | in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull |
| shortcode | string | in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull |
| archived | enum: with, only, without | eq |
| segment | enum | eq, ne, neq, in, nin, notin, isnull, isnotnull, notnull |
| primary_contact_id | id | eq, ne, neq, in, nin, notin, isnull, isnotnull, notnull |
| projects | Relation - shortcode (string) - name (string) - is_acquisition (boolean) - status (enum) | any, none, count, all |
| origin_space_id | id | eq, ne, neq, in, nin, notin, isnull, isnotnull, notnull |

Filtering expression. Accepts either JSON (array/tree of conditions) or a readable string DSL.

You can check the full syntax at Docs Filtering section.

Special values:
- me.id — current authenticated user id (usable on fields of type id). Example: id eq me.id
- now — current date-time. Example: dueOn lt now
- sow/eow — start/end of week. Examples: dueOn gt sow, dueOn lt eow
- som/eom — start/end of month. Examples: dueOn gt som, dueOn lt eom
- today — special date for today; with eq it expands to the whole day range. Example: dueOn eq today
- today±Nd — relative day offset. Examples: today-30d, today+5d.
    Example: "title contains \"Acme\" and (created_at >= \"2024-01-01\" or client.name contains \"Corp\")"

## Response 200 fields (application/json):

  - `data` (array, required)
    The list of items

  - `data.id` (string, required)

  - `data.external_id` (string,null, required)
    Can be used to add an identifier to the client from an external system, must be unique

  - `data.name` (string, required)

  - `data.shortcode` (string,null, required)

  - `data.segment` (string, required)
    Enum: "A", "B", "C"

  - `data.created_at` (string, required)

  - `data.primary_contact_id` (string,null, required)

  - `data.primaryContact` (object)

  - `data.primaryContact.first_name` (string, required)

  - `data.primaryContact.last_name` (string, required)

  - `data.primaryContact.title` (string,null, required)

  - `data.primaryContact.title_suffix` (string,null, required)

  - `data.primaryContact.email` (string, required)

  - `data.primaryContact.birthday` (string,null, required)

  - `data.primaryContact.gender` (string,null, required)

  - `data.primaryContact.position` (string,null, required)

  - `data.primaryContact.special_roles` (string,null, required)

  - `data.primaryContact.skills` (string,null, required)

  - `data.primaryContact.profile` (string,null, required)

  - `data.primaryContact.language` (string,null, required)
    UI language

  - `data.primaryContact.languages` (string,null, required)
    Spoken languages

  - `data.primaryContact.telephone_office` (string,null, required)
    Mobile phone (Office)

  - `data.primaryContact.phone_extension` (string,null, required)
    Landline phone (Office)

  - `data.primaryContact.telephone` (string,null, required)
    Mobile phone (Private)

  - `data.primaryContact.entry_date` (string,null, required)
    Date of joining the company

  - `data.primaryContact.leave_date` (string,null, required)
    Date of leaving the company - if set in the future, the employee will be archived on that date

  - `data.primaryContact.type` (string, required)
    Enum: "user", "guest", "tax_advisor"

  - `data.primaryContact.plan` (string, required)
    Enum: "basic", "standard", "external", "advanced", "expert", "guest", "tax_advisor", "not_assigned"

  - `data.primaryContact.is_owner` (boolean, required)
    Is Kanbert space owner

  - `data.primaryContact.avatar` (any, required)

  - `data.primaryContact.userGroups` (array)

  - `data.primaryContact.userGroups.is_team` (boolean, required)
    If true, this usergroup is shown as team

  - `data.primaryContact.userGroups.users` (array, required)

  - `data.primaryContact.userGroupsCount` (integer)

  - `data.primaryContact.userGroupsExists` (boolean)

  - `data.primaryContact.customFields` (object, required)
    The key is the field name for your custom field, value type depends on the field type

  - `data.primaryContact.deleted_at` (string,null, required)

  - `data.projects` (array)

  - `data.projects.external_id` (string,null, required)
    Can be used to add an identifier to the project from an external system, must be unique

  - `data.projects.po_number` (string,null, required)

  - `data.projects.projectType` (object, required)

  - `data.projects.projectType.color` (string, required)

  - `data.projects.projectType.order` (integer, required)

  - `data.projects.projectType.is_default` (boolean, required)

  - `data.projects.status` (string, required)

  - `data.projects.is_acquisition` (boolean, required)

  - `data.projects.is_private` (boolean, required)

  - `data.projects.client_id` (string, required)

  - `data.projects.project_type_id` (string,null, required)

  - `data.projects.start_date` (string,null, required)

  - `data.projects.end_date` (string,null, required)

  - `data.projects.client` (object)

  - `data.projects.tags` (array)

  - `data.projects.origin_space_id` (string,null, required)
    If set the client is shared from another Space

  - `data.projects.originSpace` (object)
    Shared space which the client is shared from

  - `data.projects.team` (array)
    Project team

  - `data.projects.team.added_at` (string, required)

  - `data.projects.team.space` (object, required)

  - `data.projects.guests` (array)
    Project guests

  - `links` (array, required)

  - `meta` (object, required)

  - `meta.path` (string,null, required)
    Base path for paginator generated URLs.

  - `meta.per_page` (integer, required)
    Number of items shown per page.

  - `meta.next_cursor` (string,null, required)

  - `meta.next_cursor_url` (string,null, required)

  - `meta.prev_cursor` (string,null, required)

  - `meta.prev_cursor_url` (string,null, required)

## Response 401 fields (application/json):

  - `message` (string, required)
    Error overview.