Skip to content
/
ProjectGroupData

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

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
descriptionstring or nullrequired
shortcodestringrequired
po_numberstring or nullrequired
project_typeProjectTypeData (object) or nullrequired
Any of:
project_type.​idstringrequired
project_type.​titlestringrequired
project_type.​shortcodestringrequired
project_type.​colorstringrequired
project_type.​orderintegerrequired
project_type.​is_defaultbooleanrequired
project_groupProjectGroupData (object) or nullrequired
Any of:
project_group.​idstringrequired
project_group.​titlestringrequired
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)
portfoliosArray of objects(ProjectPortfolioData)
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",
  "description": "string",
  "shortcode": "string",
  "po_number": "string",
  "project_type": {
    "id": "string",
    "title": "string",
    "shortcode": "string",
    "color": "string",
    "order": 0,
    "is_default": true
  },
  "project_group": {
    "id": "string",
    "title": "string"
  },
  "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": [
    { … }
  ],
  "portfolios": [
    { … }
  ],
  "custom_fields": "['custom_field_1' => 'value', 'custom_field_2' => true]",
  "origin_space": {
    "id": "string",
    "name": "string"
  },
  "team": [
    { … }
  ],
  "guests": [
    { … }
  ],
  "computed_fields": {
    "property1": 0,
    "property2": 0
  }
}

ProjectGroupData

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

ProjectPortfolioData

idstringrequired
titlestringrequired
tagsArray of stringsrequired
projects_assignedArray of objects(ProjectData)required

Projects directly assigned to this portfolio

projects_assigned[].​idstringrequired
projects_assigned[].​external_idstring or nullrequired

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

projects_assigned[].​external_originstring or nullrequired

If originated from external system origin is added

projects_assigned[].​titlestringrequired
projects_assigned[].​descriptionstring or nullrequired
projects_assigned[].​shortcodestringrequired
projects_assigned[].​po_numberstring or nullrequired
projects_assigned[].​project_typeProjectTypeData (object) or nullrequired
Any of:
projects_assigned[].​project_type.​idstringrequired
projects_assigned[].​project_type.​titlestringrequired
projects_assigned[].​project_type.​shortcodestringrequired
projects_assigned[].​project_type.​colorstringrequired
projects_assigned[].​project_type.​orderintegerrequired
projects_assigned[].​project_type.​is_defaultbooleanrequired
projects_assigned[].​project_groupProjectGroupData (object) or nullrequired
Any of:
projects_assigned[].​project_group.​idstringrequired
projects_assigned[].​project_group.​titlestringrequired
projects_assigned[].​statusstringrequired
projects_assigned[].​is_acquisitionbooleanrequired
projects_assigned[].​is_privatebooleanrequired
projects_assigned[].​start_datestring or null(date)required
projects_assigned[].​end_datestring or null(date)required
projects_assigned[].​clientobject(ClientData)required
projects_assigned[].​client.​idstringrequired
projects_assigned[].​client.​external_idstring or nullrequired

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

projects_assigned[].​client.​external_originstring or nullrequired

If originated from external system origin is added

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

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

projects_assigned[].​client.​origin_space.​idstringrequired
projects_assigned[].​client.​origin_space.​namestringrequired
projects_assigned[].​tagsArray of objects(ProjectTagData)
projects_assigned[].​portfoliosArray of objects(ProjectPortfolioData)
projects_assigned[].​custom_fieldsobjectrequired

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

projects_assigned[].​custom_fields.​property name*string or boolean or integer or nulladditional property
Any of:
string
projects_assigned[].​origin_spaceSpaceData (object) or nullrequired
Any of:

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

projects_assigned[].​origin_space.​idstringrequired
projects_assigned[].​origin_space.​namestringrequired
projects_assigned[].​teamArray of objects(TeamMemberData)

Project team

projects_assigned[].​guestsArray of objects(TeamMemberData)

Project guests

projects_assigned[].​computed_fieldsobject
shared_spacesArray of objects(SpaceData)required

Spaces the portfolio is shared with, is also empty if portfolio is shared from another space

shared_spaces[].​idstringrequired
shared_spaces[].​namestringrequired
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
{
  "id": "string",
  "title": "string",
  "tags": [
    "string"
  ],
  "projects_assigned": [
    { … }
  ],
  "shared_spaces": [
    { … }
  ],
  "origin_space": {
    "id": "string",
    "name": "string"
  }
}