The number of results that will be returned per page.
Kanbert (v1)
https://developers.kanbert.com/_bundle/openapi.json#/paths/~1users/get
Query
Available sorts are first_name, last_name, email, created_at, custom_field.<alias>.
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=sort=-created_at,title
Available includes are userGroups. You can include multiple options by separating them with a comma.
Allowed filter fields (with allowed operators):
| Field | Type | Operators |
|---|---|---|
archived | enum: with, only, without | eq |
first_name | string | in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull |
last_name | string | in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull |
email | string | in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull |
plan | enum<UserPlan> | eq, ne, neq, in, nin, notin, isnull, isnotnull, notnull |
type | enum<UserType> | eq, ne, neq, in, nin, notin, isnull, isnotnull, notnull |
is_owner | boolean | eq, ne, neq, isnull, isnotnull, notnull |
created_at | datetime | eq, ne, neq, lt, lte, le, gt, gte, ge, in, nin, notin, isnull, isnotnull, notnull |
custom_field.* — see Custom fields below | custom | eq, ne, neq, lt, lte, le, gt, gte, ge, in, nin, notin, contains, like, startswith, endswith, 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.
Custom fields: when enabled, you can filter by custom_field.<slug>. Example: custom_field.my_flag eq 'yes' or custom_field.score gte 10. Supported ops depend on the custom field type (eq, ne, in, nin, contains, startswith, endswith, isnull, isnotnull, and comparisons for numeric/date types).
Example: filter=title contains "Acme" and (created_at >= "2024-01-01" or client.name contains "Corp")
- https://api.kanbert.int/api/v1/users
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api.kanbert.int/api/v1/users?sort=sort%3D-created_at%2Ctitle&include=string&page%5Bsize%5D=30&page%5Bcursor%5D=string&filter=title+contains+%22Acme%22+and+%28created_at+%3E%3D+%222024-01-01%22+or+client.name+contains+%22Corp%22%29' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'The cursor paginated collection of UserData
The list of items
Can be used to add an identifier to the client from an external system, must be unique
Date of leaving the company - if set in the future, the employee will be archived on that date
Enum"basic""standard""external""advanced""expert""guest""tax_advisor""not_assigned"
The key is the field name for your custom field, value type depends on the field type
Response
application/json
{ "data": [ { … } ], "links": [ "string" ], "meta": { "path": "string", "per_page": 0, "next_cursor": "string", "next_cursor_url": "string", "prev_cursor": "string", "prev_cursor_url": "string" } }
https://developers.kanbert.com/_bundle/openapi.json#/paths/~1users~1{id}/get
- https://api.kanbert.int/api/v1/users/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api.kanbert.int/api/v1/users/{id}?findBy=id&include=string' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'UserData
Can be used to add an identifier to the client from an external system, must be unique
Date of leaving the company - if set in the future, the employee will be archived on that date
Enum"basic""standard""external""advanced""expert""guest""tax_advisor""not_assigned"
The key is the field name for your custom field, value type depends on the field type
Response
application/json
{ "id": "string", "external_id": "string", "first_name": "string", "last_name": "string", "title": "string", "title_suffix": "string", "email": "user@example.com", "birthday": "2019-08-24", "gender": "string", "position": "string", "special_roles": "string", "skills": "string", "profile": "string", "language": "string", "languages": "string", "telephone_office": "string", "phone_extension": "string", "telephone": "string", "entry_date": "2019-08-24", "leave_date": "2019-08-24", "type": "user", "plan": "basic", "is_owner": true, "avatar": { "id": "string", "file_name": "string", "mime_type": "string", "size": 0, "entity_id": "string", "entity_type": "string", "created_at": "string" }, "userGroups": [ { … } ], "userGroupsCount": 0, "userGroupsExists": true, "customFields": "['custom_field_1' => 'value', 'custom_field_2' => true]", "created_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z" }