Skip to content

Kanbert (v1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
https://api.kanbert.int/api/v1/

Schemas

Schemas

Clients

Operations

CustomFields

Operations

Efforts

Operations

Filter all efforts

https://developers.kanbert.com/_bundle/openapi.json#/paths/~1efforts/get

Request

Security
http
Query
page[size]integer

The number of results that will be returned per page.

Default 30
page[cursor]string

The cursor to start the pagination from.

filterstring

Allowed filter fields (with allowed operators):

FieldTypeOperators
datedateeq, ne, neq, lt, lte, le, gt, gte, ge, in, nin, notin, isnull, isnotnull, notnull
typeenum:admin, projecteq, ne, neq, in, nin, notin
project.idid<ProjectData>eq, ne, neq, in, nin, notin, isnull, isnotnull, notnull
project.external_idstringin, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
project.shortcodestringin, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
project.namestringin, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
client.idid<ClientData>eq, ne, neq, in, nin, notin, isnull, isnotnull, notnull
client.external_idstringin, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
client.namestringin, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
client.shortcodestringin, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
user.idid<UserData>eq, ne, neq, in, nin, notin, isnull, isnotnull, notnull
user.emailstringin, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
epic.idid<EpicData>eq, ne, neq, in, nin, notin, isnull, isnotnull, notnull
epic.titlestringin, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
phase.idid<PhaseData>eq, ne, neq, in, nin, notin, isnull, isnotnull, notnull
phase.titlestringin, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
phase.po_numberstringin, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
phase.start_datedateeq, ne, neq, lt, lte, le, gt, gte, ge, in, nin, notin, isnull, isnotnull, notnull
phase.end_datedateeq, ne, neq, lt, lte, le, gt, gte, ge, in, nin, notin, isnull, isnotnull, notnull
milestone.idid<MilestoneData>eq, ne, neq, in, nin, notin, isnull, isnotnull, notnull
milestone.titlestringin, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
milestone.po_numberstringin, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
milestone.datedateeq, ne, neq, lt, lte, le, gt, gte, ge, in, nin, notin, isnull, isnotnull, notnull
task.idid<TaskData>eq, ne, neq, in, nin, notin, isnull, isnotnull, notnull
task.titlestringin, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
task.uristringin, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
task.statusenum<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")
sortstring

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
curl -i -X GET \
  'https://api.kanbert.int/api/v1/efforts?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&sort=sort%3D-created_at%2Ctitle' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Computed fields are auto-attached by FilterService's apply() wrapper during pagination/fetch.

The cursor paginated collection of EffortData

Bodyapplication/json
dataArray of objects(EffortData)required

The list of items

data[].​idstringrequired
data[].​userobject(ProjectTeamData)required
data[].​user.​idstringrequired
data[].​user.​first_namestringrequired
data[].​user.​last_namestringrequired
data[].​user.​emailstringrequired
data[].​user.​typestring(UserType)required
Enum"user""guest""tax_advisor"
data[].​user.​added_atstring(date-time)required
data[].​user.​spaceobject(SpaceData)required
data[].​user.​space.​idstringrequired
data[].​user.​space.​namestringrequired
data[].​commentsstringrequired
data[].​typestringrequired
data[].​datestring(date)required
data[].​hoursnumberrequired
data[].​effortTypeEffortTypeData (object) or nullrequired
Any of:
object EffortTypeData Recursive
data[].​task_idstring or nullrequired
data[].​taskTaskData (object) or nullrequired
Any of:
object TaskData Recursive
data[].​projectProjectData (object) or nullrequired
Any of:
object ProjectData Recursive
data[].​epicEpicData (object) or nullrequired
Any of:
object EpicData Recursive
data[].​phasePhaseData (object) or nullrequired
Any of:
object PhaseData Recursive
data[].​milestoneMilestoneData (object) or nullrequired
Any of:
object MilestoneData Recursive
data[].​adminCategoryEffortAdminCategoryData (object) or nullrequired
Any of:
object EffortAdminCategoryData Recursive
linksArray of stringsrequired
metaobjectrequired
meta.​pathstring or nullrequired

Base path for paginator generated URLs.

meta.​per_pageintegerrequired

Number of items shown per page.

meta.​next_cursorstring or nullrequired
meta.​next_cursor_urlstring or nullrequired
meta.​prev_cursorstring or nullrequired
meta.​prev_cursor_urlstring or nullrequired
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"
  }
}

File

Operations

Projects

Operations

Tasks

Operations

Usergroups

Operations

Users

Operations