The number of results that will be returned per page.
Kanbert (v1)
Query
Available sorts are date.
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 |
|---|---|---|
date | date | eq, ne, neq, lt, lte, le, gt, gte, ge, in, nin, notin, isnull, isnotnull, notnull |
type | enum:admin, project | eq, ne, neq, in, nin, notin |
project.id | id<ProjectData> | eq, ne, neq, in, nin, notin, isnull, isnotnull, notnull |
project.external_id | string | in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull |
project.shortcode | string | in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull |
project.name | string | in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull |
client.id | id<ClientData> | eq, ne, neq, in, nin, notin, isnull, isnotnull, notnull |
client.external_id | string | in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull |
client.name | string | in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull |
client.shortcode | string | in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull |
user.id | id<UserData> | eq, ne, neq, in, nin, notin, isnull, isnotnull, notnull |
user.email | string | in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull |
epic.id | id<EpicData> | eq, ne, neq, in, nin, notin, isnull, isnotnull, notnull |
epic.title | string | in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull |
phase.id | id<PhaseData> | eq, ne, neq, in, nin, notin, isnull, isnotnull, notnull |
phase.title | string | in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull |
phase.po_number | string | in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull |
phase.start_date | date | eq, ne, neq, lt, lte, le, gt, gte, ge, in, nin, notin, isnull, isnotnull, notnull |
phase.end_date | date | eq, ne, neq, lt, lte, le, gt, gte, ge, in, nin, notin, isnull, isnotnull, notnull |
milestone.id | id<MilestoneData> | eq, ne, neq, in, nin, notin, isnull, isnotnull, notnull |
milestone.title | string | in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull |
milestone.po_number | string | in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull |
milestone.date | date | eq, ne, neq, lt, lte, le, gt, gte, ge, in, nin, notin, isnull, isnotnull, notnull |
task.id | id<TaskData> | eq, ne, neq, in, nin, notin, isnull, isnotnull, notnull |
task.title | string | in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull |
task.uri | string | in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull |
task.status | enum<TaskStatus> | eq, ne, neq, in, nin, notin |
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/efforts
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api.kanbert.com/api/v1/efforts?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>'Computed fields are auto-attached by FilterService's apply() wrapper during pagination/fetch.
The cursor paginated collection of EffortData
The list of items
Any of:
If originated from external system origin is added
Backlog |
New In Todo |
WIP In progress |
Completed |
Approved |
Closed Task was archived |
Enum"Backlog""New""WIP""Completed""Approved""Closed"
If false, the task is only visible to the project team - not guest users
Any of:
Enum"user""guest""tax_advisor""integration"
Default []
ID of the entity that the file belongs to
Type of the entity that the file belongs to
Any of:
Can be used to add an identifier to the project from an external system, must be unique
If originated from external system origin is added
Can be used to add an identifier to the client from an external system, must be unique
If originated from external system origin is added
Any of:
Enum"user""guest""tax_advisor""integration"
The key is the field name for your custom field, value type depends on the field type
Any of:
Any of:
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" } }