Skip to content

Kanbert (v1)

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

Schemas

Schemas

ClientData

https://developers.kanbert.com/_bundle/openapi.json#/components/schemas/ClientData
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)
{
  "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"
  }
}

ClientSegment

https://developers.kanbert.com/_bundle/openapi.json#/components/schemas/ClientSegment
string(ClientSegment)
Enum"A""B""C"
"A"

CustomFieldData

https://developers.kanbert.com/_bundle/openapi.json#/components/schemas/CustomFieldData
idstringrequired
titlestringrequired
field_namestringrequired

The field name/slug defined for your custom field

typestring(CustomFieldType)required
Enum"input""number""checkbox""select"
entity_typestring(CustomFieldEntityType)required
Enum"user""contact""company"
default_valuestring or integer or boolean or nullrequired
Any of:

Depending on the field type, this can be a string, int, bool or null

string
is_filterablebooleanrequired

If true, this field can be used for filtering in the UI

created_atstring(date-time)required
deleted_atstring or null(date-time)required
{
  "id": "string",
  "title": "string",
  "field_name": "string",
  "type": "input",
  "entity_type": "user",
  "default_value": "string",
  "is_filterable": true,
  "created_at": "2019-08-24T14:15:22Z",
  "deleted_at": "2019-08-24T14:15:22Z"
}

Clients

Operations

CustomFields

Operations

Efforts

Operations

File

Operations

Projects

Operations

Tasks

Operations

Usergroups

Operations

Users

Operations