Skip to content
/
EffortData

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

EffortAdminCategoryData

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

EffortData

idstringrequired
userobject(UserData)required
user.​idstringrequired
user.​first_namestringrequired
user.​last_namestringrequired
user.​emailstringrequired
user.​typestring(UserType)required
Enum"user""guest""tax_advisor""integration"
user.​spaceobject(SpaceData)required
user.​space.​idstringrequired
user.​space.​namestringrequired
commentsstringrequired
typestringrequired
datestring(date)required
hoursnumberrequired
effort_typeEffortTypeData (object) or nullrequired
Any of:
effort_type.​idstringrequired
effort_type.​titlestringrequired
taskTaskData (object) or nullrequired
Any of:
task.​idstringrequired
task.​project_idstringrequired
task.​client_idstringrequired
task.​parent_task_idstringrequired
task.​external_idstring or nullrequired
task.​external_originstring or nullrequired

If originated from external system origin is added

task.​uristringrequired
task.​titlestringrequired
task.​descriptionstring or nullrequired
task.​statusstring(TaskStatus)required
Backlog
New
In Todo
WIP
In progress
Completed
Approved
Closed
Task was archived
Enum"Backlog""New""WIP""Completed""Approved""Closed"
task.​typestringrequired
task.​estimated_hoursnumber or nullrequired
task.​is_onholdbooleanrequired
task.​is_publicbooleanrequired

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

task.​due_datestring or null(date)required
task.​due_date_settingsobject(TaskDueDateSettingsData)required
task.​due_date_settings.​is_hard_deadlinebooleanrequired
Default false
task.​due_date_settings.​recurring_typeTaskDueDateRecurringType (string) or nullrequired
Any of:
string(TaskDueDateRecurringType)
Enum"daily""weekly""monthly"
task.​due_date_settings.​recurring_intervalinteger or nullrequired

Integer offset if recurring_type = daily or NULL -> offset ignored
if recurring_type = weekly -> 1 = every Monday, 2 = every Tuesday, etc
if recurring_type = monthly -> 1 = every month, 2 = every 2 months, etc

task.​assigneeUserData (object) or nullrequired
Any of:
task.​assignee.​idstringrequired
task.​assignee.​first_namestringrequired
task.​assignee.​last_namestringrequired
task.​assignee.​emailstringrequired
task.​assignee.​typestring(UserType)required
Enum"user""guest""tax_advisor""integration"
task.​assignee.​spaceobject(SpaceData)required
task.​assignee.​space.​idstringrequired
task.​assignee.​space.​namestringrequired
task.​priorityOptionTaskPriorityOptionData (object) or nullrequired
Any of:
task.​priorityOption.​idstringrequired
task.​priorityOption.​labelstringrequired
task.​phasePhaseData (object) or null
Any of:
task.​milestoneMilestoneData (object) or null
Any of:
task.​epicEpicData (object) or null
Any of:
task.​parent_taskTaskData (object) or null
Any of:
object TaskData Recursive
task.​attachementsArray of objects(FileData)required
Default []
task.​attachements[].​idstringrequired
task.​attachements[].​file_namestringrequired
task.​attachements[].​mime_typestringrequired
task.​attachements[].​sizeintegerrequired

File size in bytes

task.​attachements[].​entity_idstringrequired

ID of the entity that the file belongs to

task.​attachements[].​entity_typestringrequired

Type of the entity that the file belongs to

task.​attachements[].​created_atstringrequired
task.​watchersArray of objects(UserData)
task.​sub_tasksArray of objects(TaskData)required
task.​completed_atstring or null(date-time)required
task.​closed_atstring or null(date-time)required
task.​updated_atstring or null(date-time)required
task.​created_atstring or null(date-time)required
task.​list_sortingintegerrequired
projectProjectData (object) or nullrequired
Any of:
project.​idstringrequired
project.​external_idstring or nullrequired

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

project.​external_originstring or nullrequired

If originated from external system origin is added

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

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

project.​client.​external_originstring or nullrequired

If originated from external system origin is added

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

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

project.​client.​origin_space.​idstringrequired
project.​client.​origin_space.​namestringrequired
project.​tagsArray of objects(ProjectTagData)
project.​custom_fieldsobjectrequired

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

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

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

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

Project team

project.​guestsArray of objects(TeamMemberData)

Project guests

project.​computed_fieldsobject
epicEpicData (object) or nullrequired
Any of:
epic.​idstringrequired
epic.​titlestringrequired
epic.​po_numberstring or nullrequired
epic.​computed_fieldsobject
phasePhaseData (object) or nullrequired
Any of:
phase.​idstringrequired
phase.​titlestringrequired
phase.​po_numberstring or nullrequired
phase.​groupPhaseGroupData (object) or nullrequired
Any of:
phase.​group.​idstringrequired
phase.​group.​titlestringrequired
phase.​typePhaseTypeData (object) or nullrequired
Any of:
phase.​type.​idstringrequired
phase.​type.​titlestringrequired
phase.​type.​colorstringrequired
phase.​dependency_phase_idstring or nullrequired
phase.​dependency_milestone_idstring or nullrequired
phase.​start_datestring or null(date)required
phase.​end_datestring or null(date)required
phase.​created_atstring or null(date-time)required
phase.​computed_fieldsobject
milestoneMilestoneData (object) or nullrequired
Any of:
milestone.​idstringrequired
milestone.​titlestringrequired
milestone.​po_numberstring or nullrequired
milestone.​groupPhaseGroupData (object) or nullrequired
Any of:
milestone.​group.​idstringrequired
milestone.​group.​titlestringrequired
milestone.​dependency_phase_idstring or nullrequired
milestone.​dependency_milestone_idstring or nullrequired
milestone.​datestring(date)required
milestone.​created_atstring or null(date-time)required
milestone.​computed_fieldsobject
admin_categoryEffortAdminCategoryData (object) or nullrequired
Any of:
admin_category.​idstringrequired
admin_category.​titlestringrequired
{
  "id": "string",
  "user": {
    "id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "type": "user",
    "space": { … }
  },
  "comments": "string",
  "type": "string",
  "date": "2019-08-24",
  "hours": 0,
  "effort_type": {
    "id": "string",
    "title": "string"
  },
  "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
  },
  "project": {
    "id": "string",
    "external_id": "string",
    "external_origin": "string",
    "title": "string",
    "shortcode": "string",
    "po_number": "string",
    "project_type": { … },
    "status": "string",
    "is_acquisition": true,
    "is_private": true,
    "start_date": "2019-08-24",
    "end_date": "2019-08-24",
    "client": { … },
    "tags": [ … ],
    "custom_fields": "['custom_field_1' => 'value', 'custom_field_2' => true]",
    "origin_space": { … },
    "team": [ … ],
    "guests": [ … ],
    "computed_fields": { … }
  },
  "epic": {
    "id": "string",
    "title": "string",
    "po_number": "string",
    "computed_fields": { … }
  },
  "phase": {
    "id": "string",
    "title": "string",
    "po_number": "string",
    "group": { … },
    "type": { … },
    "dependency_phase_id": "string",
    "dependency_milestone_id": "string",
    "start_date": "2019-08-24",
    "end_date": "2019-08-24",
    "created_at": "2019-08-24T14:15:22Z",
    "computed_fields": { … }
  },
  "milestone": {
    "id": "string",
    "title": "string",
    "po_number": "string",
    "group": { … },
    "dependency_phase_id": "string",
    "dependency_milestone_id": "string",
    "date": "2019-08-24",
    "created_at": "2019-08-24T14:15:22Z",
    "computed_fields": { … }
  },
  "admin_category": {
    "id": "string",
    "title": "string"
  }
}

EffortTypeData

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