Skip to content
/
UserData

Kanbert (v1)

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

Users

Operations

Clients

Operations

Projects

Operations

Portfolios & Project Groups

Operations

Tasks

Operations
Webhooks

Task Comments

Operations
Webhooks

Efforts

Operations

Contacts

Operations

Companies

Operations
Webhooks

Offers

Operations

Outgoing Invoices

Operations

Incoming Invoices

Operations

Chart of Accounts

Operations

Payments

Operations

Usergroups & Teams

Operations

Suppliers

Operations

Settings

Operations

Integration

Operations

Files

Operations

Custom Fields

Operations

Webhook Management

Operations

Schemas

Schemas

TeamMemberData

idstringrequired
first_namestringrequired
last_namestringrequired
emailstringrequired
typestring(UserType)required
Enum"user""guest""tax_advisor""integration"
is_project_leadbooleanrequired
added_atstring(date-time)required
spaceobject(SpaceData)required
space.​idstringrequired
space.​namestringrequired
{
  "id": "string",
  "first_name": "string",
  "last_name": "string",
  "email": "string",
  "type": "user",
  "is_project_lead": true,
  "added_at": "2019-08-24T14:15:22Z",
  "space": {
    "id": "string",
    "name": "string"
  }
}

UserData

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

UserFullData

idstringrequired
external_idstring or nullrequired

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

external_originstring or nullrequired

If originated from external system origin is added

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

UI language

languagesstring or nullrequired

Spoken languages

telephone_officestring or nullrequired

Mobile phone (Office)

phone_extensionstring or nullrequired

Landline phone (Office)

telephonestring or nullrequired

Mobile phone (Private)

entry_datestring or null(date)required

Date of joining the company

leave_datestring or null(date)required

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

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

Is Kanbert space owner

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

File size in bytes

avatar.​entity_idstringrequired

ID of the entity that the file belongs to

avatar.​entity_typestringrequired

Type of the entity that the file belongs to

avatar.​created_atstringrequired
userGroupsArray of objects(UsergroupData)
custom_fieldsobjectrequired

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

custom_fields.​property name*string or boolean or integer or nulladditional property
Any of:
string
created_atstring(date-time)required
deleted_atstring or null(date-time)required
{
  "id": "string",
  "external_id": "string",
  "external_origin": "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": {
    "id": "string",
    "file_name": "string",
    "mime_type": "string",
    "size": 0,
    "entity_id": "string",
    "entity_type": "string",
    "created_at": "string"
  },
  "userGroups": [
    { … }
  ],
  "custom_fields": "['custom_field_1' => 'value', 'custom_field_2' => true]",
  "created_at": "2019-08-24T14:15:22Z",
  "deleted_at": "2019-08-24T14:15:22Z"
}