Skip to content
/
UserType

Kanbert (v1)

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

Schemas

Schemas

UserPlan

https://developers.kanbert.com/_bundle/openapi.json#/components/schemas/UserPlan
string(UserPlan)
Enum"basic""standard""external""advanced""expert""guest""tax_advisor""not_assigned"
"basic"

UserType

https://developers.kanbert.com/_bundle/openapi.json#/components/schemas/UserType
string(UserType)
Enum"user""guest""tax_advisor"
"user"

UsergroupData

https://developers.kanbert.com/_bundle/openapi.json#/components/schemas/UsergroupData
idstringrequired
external_idstring or nullrequired

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

namestringrequired
is_teambooleanrequired

If true, this usergroup is shown as team

usersArray of objects(UserData)required
users[].​idstringrequired
users[].​external_idstring or nullrequired

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

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

UI language

users[].​languagesstring or nullrequired

Spoken languages

users[].​telephone_officestring or nullrequired

Mobile phone (Office)

users[].​phone_extensionstring or nullrequired

Landline phone (Office)

users[].​telephonestring or nullrequired

Mobile phone (Private)

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

Date of joining the company

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

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

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

Is Kanbert space owner

users[].​avatarFileData (object) or nullrequired
Any of:
object FileData Recursive
users[].​userGroupsArray of objects(UsergroupData)
users[].​userGroupsCountinteger
users[].​userGroupsExistsboolean
users[].​customFieldsobjectrequired

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

users[].​customFields.​property name*string or boolean or integer or nulladditional property
Any of:
string
users[].​created_atstring(date-time)required
users[].​deleted_atstring or null(date-time)required
{
  "id": "string",
  "external_id": "string",
  "name": "string",
  "is_team": true,
  "users": [
    { … }
  ]
}

Clients

Operations

CustomFields

Operations

Efforts

Operations

File

Operations

Projects

Operations

Tasks

Operations

Usergroups

Operations

Users

Operations