The number of results that will be returned per page.
Kanbert (v1)
Query
Available sorts are name, shortcode.
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
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 |
primary_contact.id | id<UserData> | eq, ne, neq, in, nin, notin, isnull, isnotnull, notnull |
origin_space.id | id<SpaceData> | 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: filter=title contains "Acme" and (created_at >= "2024-01-01" or client.name contains "Corp")
- https://api.kanbert.com/api/v1/clients
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api.kanbert.com/api/v1/clients?sort=sort%3D-created_at%2Ctitle&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>'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" } }
Bodyapplication/jsonrequired
Can be used to add an identifier from an external system, must be unique within integration (integration slug)
If not provided, the shortcode will be generated, Shortcode must be unique
- https://api.kanbert.com/api/v1/clients
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api.kanbert.com/api/v1/clients \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"external_id": "string",
"external_origin": "string",
"name": "string",
"shortcode": "string",
"segment": "A",
"primary_contact_id": "string"
}'Response
application/json
{ "id": "string", "external_id": "string", "external_origin": "string", "name": "string", "shortcode": "string", "segment": "A", "updated_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "primary_contact": { "id": "string", "first_name": "string", "last_name": "string", "email": "string", "type": "user", "space": { … } }, "projects": [ { … } ], "origin_space": { "id": "string", "name": "string" } }
Query
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=sort=-created_at,title
Available includes are projects. You can include multiple options by separating them with a comma.
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<ClientSegment> | eq, ne, neq, in, nin, notin, isnull, isnotnull, notnull |
primary_contact.id | id<UserData> | 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<SpaceData> | 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: filter=title contains "Acme" and (created_at >= "2024-01-01" or client.name contains "Corp")
- https://api.kanbert.com/api/v1/clients/full
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api.kanbert.com/api/v1/clients/full?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>'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://api.kanbert.com/api/v1/clients/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api.kanbert.com/api/v1/clients/{id}?find_by=id&origin=string&include=string' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Response
application/json
{ "id": "string", "external_id": "string", "external_origin": "string", "name": "string", "shortcode": "string", "primary_contact": { "id": "string", "first_name": "string", "last_name": "string", "email": "string", "type": "user", "space": { … } }, "origin_space": { "id": "string", "name": "string" } }
- https://api.kanbert.com/api/v1/clients/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://api.kanbert.com/api/v1/clients/{id}?find_by=id&origin=string' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"name": "string",
"segment": "A",
"primary_contact_id": "string"
}'Response
application/json
{ "id": "string", "external_id": "string", "external_origin": "string", "name": "string", "shortcode": "string", "primary_contact": { "id": "string", "first_name": "string", "last_name": "string", "email": "string", "type": "user", "space": { … } }, "origin_space": { "id": "string", "name": "string" } }
- https://api.kanbert.com/api/v1/clients/{id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://api.kanbert.com/api/v1/clients/{id}?find_by=id&origin=string' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Response
application/json
{ "message": "Client deleted successfully" }
Bodyapplication/json
Can be used to add an identifier to the client from an external system, must be unique within integration (integration slug)
- https://api.kanbert.com/api/v1/clients/{id}/external-identifier
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://api.kanbert.com/api/v1/clients/{id}/external-identifier?find_by=id&origin=string' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"external_id": "string",
"external_origin": "string"
}'Response
application/json
{ "id": "string", "external_id": "string", "external_origin": "string", "name": "string", "shortcode": "string", "primary_contact": { "id": "string", "first_name": "string", "last_name": "string", "email": "string", "type": "user", "space": { … } }, "origin_space": { "id": "string", "name": "string" } }
- https://api.kanbert.com/api/v1/clients/{id}/shortcode
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
'https://api.kanbert.com/api/v1/clients/{id}/shortcode?find_by=id&origin=string' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"shortcode": "string"
}'Response
application/json
{ "id": "string", "external_id": "string", "external_origin": "string", "name": "string", "shortcode": "string", "primary_contact": { "id": "string", "first_name": "string", "last_name": "string", "email": "string", "type": "user", "space": { … } }, "origin_space": { "id": "string", "name": "string" } }
- https://api.kanbert.com/api/v1/clients/{id}/restore
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://api.kanbert.com/api/v1/clients/{id}/restore?find_by=id&origin=string' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'Response
application/json
{ "id": "string", "external_id": "string", "external_origin": "string", "name": "string", "shortcode": "string", "segment": "A", "updated_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "primary_contact": { "id": "string", "first_name": "string", "last_name": "string", "email": "string", "type": "user", "space": { … } }, "projects": [ { … } ], "origin_space": { "id": "string", "name": "string" } }