Skip to content
/
ProjectTagData

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

ProjectData

idstringrequired
external_idstring or nullrequired

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

external_originstring or nullrequired

If originated from external system origin is added

titlestringrequired
shortcodestringrequired
po_numberstring or nullrequired
project_typeobject(ProjectTypeData)required
project_type.​idstringrequired
project_type.​titlestringrequired
project_type.​shortcodestringrequired
project_type.​colorstringrequired
project_type.​orderintegerrequired
project_type.​is_defaultbooleanrequired
statusstringrequired
is_acquisitionbooleanrequired
is_privatebooleanrequired
start_datestring or null(date)required
end_datestring or null(date)required
clientobject(ClientData)required
client.​idstringrequired
client.​external_idstring or nullrequired

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

client.​external_originstring or nullrequired

If originated from external system origin is added

client.​namestringrequired
client.​shortcodestring or nullrequired
client.​primary_contactUserData (object) or nullrequired
Any of:
client.​primary_contact.​idstringrequired
client.​primary_contact.​first_namestringrequired
client.​primary_contact.​last_namestringrequired
client.​primary_contact.​emailstringrequired
client.​primary_contact.​typestring(UserType)required
Enum"user""guest""tax_advisor""integration"
client.​primary_contact.​spaceobject(SpaceData)required
client.​primary_contact.​space.​idstringrequired
client.​primary_contact.​space.​namestringrequired
client.​origin_spaceSpaceData (object) or nullrequired
Any of:

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

client.​origin_space.​idstringrequired
client.​origin_space.​namestringrequired
tagsArray of objects(ProjectTagData)
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
origin_spaceSpaceData (object) or nullrequired
Any of:

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

origin_space.​idstringrequired
origin_space.​namestringrequired
teamArray of objects(TeamMemberData)

Project team

guestsArray of objects(TeamMemberData)

Project guests

computed_fieldsobject
{
  "id": "string",
  "external_id": "string",
  "external_origin": "string",
  "title": "string",
  "shortcode": "string",
  "po_number": "string",
  "project_type": {
    "id": "string",
    "title": "string",
    "shortcode": "string",
    "color": "string",
    "order": 0,
    "is_default": true
  },
  "status": "string",
  "is_acquisition": true,
  "is_private": true,
  "start_date": "2019-08-24",
  "end_date": "2019-08-24",
  "client": {
    "id": "string",
    "external_id": "string",
    "external_origin": "string",
    "name": "string",
    "shortcode": "string",
    "primary_contact": { … },
    "origin_space": { … }
  },
  "tags": [
    { … }
  ],
  "custom_fields": "['custom_field_1' => 'value', 'custom_field_2' => true]",
  "origin_space": {
    "id": "string",
    "name": "string"
  },
  "team": [
    { … }
  ],
  "guests": [
    { … }
  ],
  "computed_fields": {
    "property1": 0,
    "property2": 0
  }
}

ProjectTagData

idstringrequired
titlestringrequired
{
  "id": "string",
  "title": "string"
}

ProjectTypeData

idstringrequired
titlestringrequired
shortcodestringrequired
colorstringrequired
orderintegerrequired
is_defaultbooleanrequired
{
  "id": "string",
  "title": "string",
  "shortcode": "string",
  "color": "string",
  "order": 0,
  "is_default": true
}