Skip to content
/
ClientSegment

Kanbert (v1)

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

Users

Operations

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

ClientFullData

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

namestringrequired
shortcodestring or nullrequired
segmentstring(ClientSegment)required
Default "B"
Enum"A""B""C"
updated_atstring(date-time)required
created_atstring(date-time)required
primary_contactUserData (object) or nullrequired
Any of:
primary_contact.​idstringrequired
primary_contact.​first_namestringrequired
primary_contact.​last_namestringrequired
primary_contact.​emailstringrequired
primary_contact.​typestring(UserType)required
Enum"user""guest""tax_advisor""integration"
primary_contact.​spaceobject(SpaceData)required
primary_contact.​space.​idstringrequired
primary_contact.​space.​namestringrequired
projectsArray of objects(ProjectData)
origin_spaceSpaceData (object) or nullrequired
Any of:

Shared space which the client is shared from, if null client is not shared

origin_space.​idstringrequired
origin_space.​namestringrequired
{
  "id": "string",
  "external_id": "string",
  "external_origin": "string",
  "name": "string",
  "shortcode": "string",
  "segment": "A",
  "updated_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "primary_contact": {
    "id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "type": "user",
    "space": { … }
  },
  "projects": [
    { … }
  ],
  "origin_space": {
    "id": "string",
    "name": "string"
  }
}

ClientSegment

string(ClientSegment)
Enum"A""B""C"
"A"

CommentData

idstringrequired
external_idstring or nullrequired
external_originstring or nullrequired

If originated from external system origin is added

parent_comment_idstring or nullrequired
parent_commentCommentData (object) or null
Any of:
object CommentData Recursive
taskTaskData (object) or null
Any of:
sub_commentsArray of objects(CommentData)required
authorobject(UserData)required
author.​idstringrequired
author.​first_namestringrequired
author.​last_namestringrequired
author.​emailstringrequired
author.​typestring(UserType)required
Enum"user""guest""tax_advisor""integration"
author.​spaceobject(SpaceData)required
author.​space.​idstringrequired
author.​space.​namestringrequired
commentstring or nullrequired
attachementsArray of objects(FileData)required
Default []
attachements[].​idstringrequired
attachements[].​file_namestringrequired
attachements[].​mime_typestringrequired
attachements[].​sizeintegerrequired

File size in bytes

attachements[].​entity_idstringrequired

ID of the entity that the file belongs to

attachements[].​entity_typestringrequired

Type of the entity that the file belongs to

attachements[].​created_atstringrequired
is_publicbooleanrequired

If false, the task is only visible to the project team - not guest users

created_atstring or null(date-time)required
updated_atstring or null(date-time)required
{
  "id": "string",
  "external_id": "string",
  "external_origin": "string",
  "parent_comment_id": "string",
  "parent_comment": {},
  "task": {
    "id": "string",
    "project_id": "string",
    "client_id": "string",
    "parent_task_id": "string",
    "external_id": "string",
    "external_origin": "string",
    "uri": "string",
    "title": "string",
    "description": "string",
    "status": "Backlog",
    "type": "string",
    "estimated_hours": 0,
    "is_onhold": true,
    "is_public": true,
    "due_date": "2019-08-24",
    "due_date_settings": { … },
    "assignee": { … },
    "priorityOption": { … },
    "phase": { … },
    "milestone": { … },
    "epic": { … },
    "parent_task": {},
    "attachements": [],
    "watchers": [ … ],
    "sub_tasks": [ … ],
    "completed_at": "2019-08-24T14:15:22Z",
    "closed_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "list_sorting": 0
  },
  "sub_comments": [
    {}
  ],
  "author": {
    "id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "type": "user",
    "space": { … }
  },
  "comment": "string",
  "attachements": [],
  "is_public": true,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}