Skip to content
/
List all users (basic)

Kanbert (v1)

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

Users

Operations

Retrieve current user's information

Request

No specific scope required.

Security
http or oauth2
curl -i -X GET \
  https://api.kanbert.com/api/v1/whoami \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

UserData

Bodyapplication/json
idstringrequired
first_namestringrequired
last_namestringrequired
emailstringrequired
typestring(UserType)required
Enum"user""guest""tax_advisor""integration"
spaceobject(SpaceData)required
space.​idstringrequired
space.​namestringrequired
Response
application/json
{
  "id": "string",
  "first_name": "string",
  "last_name": "string",
  "email": "string",
  "type": "user",
  "space": {
    "id": "string",
    "name": "string"
  }
}

List all users (basic)

Request

No specific scope required.

Security
http or oauth2
Query
sortstring

Available sorts are first_name, last_name, email.
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
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
first_namestringin, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
last_namestringin, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
emailstringin, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
typeenum<UserType>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.com/api/v1/users?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>'

Responses

The cursor paginated collection of DWI.Http.Data.Api.V1.UserData

Bodyapplication/json
dataArray of objects(UserData)required

The list of items

data[].​idstringrequired
data[].​first_namestringrequired
data[].​last_namestringrequired
data[].​emailstringrequired
data[].​typestring(UserType)required
Enum"user""guest""tax_advisor""integration"
data[].​spaceobject(SpaceData)required
data[].​space.​idstringrequired
data[].​space.​namestringrequired
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"
  }
}

Get all users (full)

Request

Required scopes: user:read

Security
http or oauth2
Query
sortstring

Available sorts are first_name, last_name, email, created_at, custom_fields.<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
includestring

Available includes are user_groups. 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
archivedenum: with, only, withouteq
first_namestringin, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
last_namestringin, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
emailstringin, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
planenum<UserPlan>eq, ne, neq, in, nin, notin, isnull, isnotnull, notnull
typeenum<UserType>eq, ne, neq, in, nin, notin, isnull, isnotnull, notnull
is_ownerbooleaneq, ne, neq, isnull, isnotnull, notnull
created_atdatetimeeq, ne, neq, lt, lte, le, gt, gte, ge, in, nin, notin, isnull, isnotnull, notnull
custom_fields.* — see Custom fields belowcustomeq, 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_fields.<slug>. Example: custom_fields.my_flag eq 'yes' or custom_fields.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")
curl -i -X GET \
  'https://api.kanbert.com/api/v1/users/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>'

Responses

The cursor paginated collection of UserFullData

Bodyapplication/json
dataArray of objects(UserFullData)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[].​external_originstring or nullrequired

If originated from external system origin is added

data[].​first_namestringrequired
data[].​last_namestringrequired
data[].​titlestring or nullrequired
data[].​title_suffixstring or nullrequired
data[].​emailstring(email)required
data[].​birthdaystring or null(date)required
data[].​genderstring or nullrequired
data[].​positionstring or nullrequired
data[].​special_rolesstring or nullrequired
data[].​skillsstring or nullrequired
data[].​profilestring or nullrequired
data[].​languagestring or nullrequired

UI language

data[].​languagesstring or nullrequired

Spoken languages

data[].​telephone_officestring or nullrequired

Mobile phone (Office)

data[].​phone_extensionstring or nullrequired

Landline phone (Office)

data[].​telephonestring or nullrequired

Mobile phone (Private)

data[].​entry_datestring or null(date)required

Date of joining the company

data[].​leave_datestring or null(date)required

Date of leaving the company - if set in the future, the employee will be archived on that date

data[].​typestring(UserType)required
Enum"user""guest""tax_advisor""integration"
data[].​planstring(UserPlan)required
Enum"basic""standard""external""advanced""expert""guest""tax_advisor""integration""not_assigned"
data[].​is_ownerbooleanrequired

Is Kanbert space owner

data[].​avatarFileData (object) or nullrequired
Any of:
data[].​avatar.​idstringrequired
data[].​avatar.​file_namestringrequired
data[].​avatar.​mime_typestringrequired
data[].​avatar.​sizeintegerrequired

File size in bytes

data[].​avatar.​entity_idstringrequired

ID of the entity that the file belongs to

data[].​avatar.​entity_typestringrequired

Type of the entity that the file belongs to

data[].​avatar.​created_atstringrequired
data[].​userGroupsArray of objects(UsergroupData)
data[].​custom_fieldsobjectrequired

The key is the field name for your custom field, value type depends on the field type

data[].​custom_fields.​property name*string or boolean or integer or nulladditional property
Any of:
string
data[].​created_atstring(date-time)required
data[].​deleted_atstring or null(date-time)required
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"
  }
}

Retrieve a user

Request

No specific scope required.

Returns UserFullData if app has any user:* scope or user-profile:* if current user

Security
http or oauth2
Path
idstringrequired
Query
find_bystring

The field to search by

Default "id"
Enum"id""external_id""shortcode"
originstring

Used if find_by=external_id by default it will use the integration slug

includestring

Available includes are user_groups. You can include multiple options by separating them with a comma.

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

Responses

UserData

UserFullData

Bodyapplication/json
Any of:
idstringrequired
first_namestringrequired
last_namestringrequired
emailstringrequired
typestring(UserType)required
Enum"user""guest""tax_advisor""integration"
spaceobject(SpaceData)required
space.​idstringrequired
space.​namestringrequired
Response
application/json
{
  "id": "string",
  "first_name": "string",
  "last_name": "string",
  "email": "string",
  "type": "user",
  "space": {
    "id": "string",
    "name": "string"
  }
}

Clients

Operations

Projects

Operations

Tasks

Operations
Webhooks

Task Comments

Operations
Webhooks

Efforts

Operations

Contacts

Operations

Companies

Operations
Webhooks

Offers

Operations

Outgoing Invoices

Operations

Payments

Operations

Usergroups & Teams

Operations

Settings

Operations

Integration

Operations

Files

Operations

Custom Fields

Operations

Webhook Management

Operations

Schemas

Schemas