Skip to content

Kanbert (v1)

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

Schemas

Schemas

Clients

Operations

Filter all clients

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

Request

Security
http
Query
sortstring

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
includestring

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.

Default 30
page[cursor]string

The cursor to start the pagination from.

filterstring

Allowed filter fields (with allowed operators):

FieldTypeOperators
namestringin, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
shortcodestringin, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
archivedenum: with, only, withouteq
segmentenum<ClientSegment>eq, ne, neq, in, nin, notin, isnull, isnotnull, notnull
primary_contact_idid<UserData>eq, ne, neq, in, nin, notin, isnull, isnotnull, notnull
projectsRelation
- shortcode (string)
- name (string)
- is_acquisition (boolean)
- status (enum)		any, none, count, all
origin_space_idid<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")
curl -i -X GET \
  'https://api.kanbert.int/api/v1/clients?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>'

Responses

The cursor paginated collection of ClientData

Bodyapplication/json
dataArray of objects(ClientData)required

The list of items

data[].​idstringrequired
data[].​external_idstring or nullrequired

Can be used to add an identifier to the client from an external system, must be unique

data[].​namestringrequired
data[].​shortcodestring or nullrequired
data[].​segmentstring(ClientSegment)required
Default "B"
Enum"A""B""C"
data[].​created_atstring(date-time)required
data[].​primary_contact_idstring or nullrequired
data[].​primaryContactobject(UserData)
data[].​projectsArray of objects(ProjectData)
data[].​origin_space_idstring or nullrequired

If set the client is shared from another Space

data[].​originSpaceobject(SpaceData)
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"
  }
}

Create new client

https://developers.kanbert.com/_bundle/openapi.json#/paths/~1clients/post

Request

Security
http
Bodyapplication/jsonrequired
external_idstring or null<= 255 characters

Can be used to add an identifier to the client from an external system, must be unique

namestring<= 255 charactersrequired
shortcodestring or null<= 255 characters

If not provided, the shortcode will be generated, Shortcode must be unique

segmentstring
Default "B"
Enum"A""B""C"
primary_contact_idstring or null

User ID of the account manager

curl -i -X POST \
  https://api.kanbert.int/api/v1/clients \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "external_id": "string",
    "name": "string",
    "shortcode": "string",
    "segment": "A",
    "primary_contact_id": "string"
  }'

Responses

ClientData

Bodyapplication/json
idstringrequired
external_idstring or nullrequired

Can be used to add an identifier to the client from an external system, must be unique

namestringrequired
shortcodestring or nullrequired
segmentstring(ClientSegment)required
Default "B"
Enum"A""B""C"
created_atstring(date-time)required
primary_contact_idstring or nullrequired
primaryContactobject(UserData)
projectsArray of objects(ProjectData)
origin_space_idstring or nullrequired

If set the client is shared from another Space

originSpaceobject(SpaceData)
Response
application/json
{
  "id": "string",
  "external_id": "string",
  "name": "string",
  "shortcode": "string",
  "segment": "A",
  "created_at": "2019-08-24T14:15:22Z",
  "primary_contact_id": "string",
  "primaryContact": {
    "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": { … },
    "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"
  },
  "projects": [
    { … }
  ],
  "origin_space_id": "string",
  "originSpace": {
    "id": "string",
    "name": "string"
  }
}

Show single client

https://developers.kanbert.com/_bundle/openapi.json#/paths/~1clients~1{id}/get

Request

Security
http
Path
idstringrequired
Query
findBystring

The field to search by

Default "id"
Enum"id""external_id""shortcode"
includestring

Available includes are primaryContact, projects, originSpace. You can include multiple options by separating them with a comma.

curl -i -X GET \
  'https://api.kanbert.int/api/v1/clients/{id}?findBy=id&include=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

ClientData

Bodyapplication/json
idstringrequired
external_idstring or nullrequired

Can be used to add an identifier to the client from an external system, must be unique

namestringrequired
shortcodestring or nullrequired
segmentstring(ClientSegment)required
Default "B"
Enum"A""B""C"
created_atstring(date-time)required
primary_contact_idstring or nullrequired
primaryContactobject(UserData)
projectsArray of objects(ProjectData)
origin_space_idstring or nullrequired

If set the client is shared from another Space

originSpaceobject(SpaceData)
Response
application/json
{
  "id": "string",
  "external_id": "string",
  "name": "string",
  "shortcode": "string",
  "segment": "A",
  "created_at": "2019-08-24T14:15:22Z",
  "primary_contact_id": "string",
  "primaryContact": {
    "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": { … },
    "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"
  },
  "projects": [
    { … }
  ],
  "origin_space_id": "string",
  "originSpace": {
    "id": "string",
    "name": "string"
  }
}

Update client

https://developers.kanbert.com/_bundle/openapi.json#/paths/~1clients~1{id}/put

Request

Security
http
Path
idstringrequired
Query
findBystring

The field to search by

Default "id"
Enum"id""external_id""shortcode"
Bodyapplication/json
external_idstring or null<= 255 characters
namestring<= 255 characters
shortcodestring or null<= 255 characters

If not provided, the shortcode will be generated, Shortcode must be unique

segmentstring
Default "B"
Enum"A""B""C"
primary_contact_idstring or null

User ID of the account manager

curl -i -X PUT \
  'https://api.kanbert.int/api/v1/clients/{id}?findBy=id' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "external_id": "string",
    "name": "string",
    "shortcode": "string",
    "segment": "A",
    "primary_contact_id": "string"
  }'

Responses

ClientData

Bodyapplication/json
idstringrequired
external_idstring or nullrequired

Can be used to add an identifier to the client from an external system, must be unique

namestringrequired
shortcodestring or nullrequired
segmentstring(ClientSegment)required
Default "B"
Enum"A""B""C"
created_atstring(date-time)required
primary_contact_idstring or nullrequired
primaryContactobject(UserData)
projectsArray of objects(ProjectData)
origin_space_idstring or nullrequired

If set the client is shared from another Space

originSpaceobject(SpaceData)
Response
application/json
{
  "id": "string",
  "external_id": "string",
  "name": "string",
  "shortcode": "string",
  "segment": "A",
  "created_at": "2019-08-24T14:15:22Z",
  "primary_contact_id": "string",
  "primaryContact": {
    "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": { … },
    "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"
  },
  "projects": [
    { … }
  ],
  "origin_space_id": "string",
  "originSpace": {
    "id": "string",
    "name": "string"
  }
}

Archive client

https://developers.kanbert.com/_bundle/openapi.json#/paths/~1clients~1{id}/delete

Request

Security
http
Path
idstringrequired
Query
findBystring

The field to search by

Default "id"
Enum"id""external_id""shortcode"
curl -i -X DELETE \
  'https://api.kanbert.int/api/v1/clients/{id}?findBy=id' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
messagestringrequired
Value"Client deleted successfully"
Response
application/json
{
  "message": "Client deleted successfully"
}

Restore client

https://developers.kanbert.com/_bundle/openapi.json#/paths/~1clients~1{id}~1restore/put

Request

Security
http
Path
idstringrequired
Query
findBystring

The field to search by

Default "id"
Enum"id""external_id""shortcode"
curl -i -X PUT \
  'https://api.kanbert.int/api/v1/clients/{id}/restore?findBy=id' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

ClientData

Bodyapplication/json
idstringrequired
external_idstring or nullrequired

Can be used to add an identifier to the client from an external system, must be unique

namestringrequired
shortcodestring or nullrequired
segmentstring(ClientSegment)required
Default "B"
Enum"A""B""C"
created_atstring(date-time)required
primary_contact_idstring or nullrequired
primaryContactobject(UserData)
projectsArray of objects(ProjectData)
origin_space_idstring or nullrequired

If set the client is shared from another Space

originSpaceobject(SpaceData)
Response
application/json
{
  "id": "string",
  "external_id": "string",
  "name": "string",
  "shortcode": "string",
  "segment": "A",
  "created_at": "2019-08-24T14:15:22Z",
  "primary_contact_id": "string",
  "primaryContact": {
    "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": { … },
    "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"
  },
  "projects": [
    { … }
  ],
  "origin_space_id": "string",
  "originSpace": {
    "id": "string",
    "name": "string"
  }
}

CustomFields

Operations

Efforts

Operations

File

Operations

Projects

Operations

Tasks

Operations

Usergroups

Operations

Users

Operations