Skip to content
/
CountryData

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

ContactData

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

genderstring or nullrequired
first_namestring or nullrequired
last_namestring or nullrequired
titlestring or nullrequired
title_suffixstring or nullrequired
positionstring or nullrequired
localestring or nullrequired
birthdaystring or null(date)required
faxstring or nullrequired
telephonestring or nullrequired
telephone_privatestring or nullrequired
mobilestring or nullrequired
mobile_privatestring or nullrequired
emailstring or null(email)required
email_privatestring or null(email)required
address_streetstring or nullrequired
address_housestring or nullrequired
address_street2string or nullrequired
address_zipstring or nullrequired
address_statestring or nullrequired
address_townstring or nullrequired
address_countryCountryData (object) or nullrequired
Any of:
address_country.​idstringrequired
address_country.​namestringrequired
address_country.​codestring(ISO 3166-1 alpha-2)required
ownerUserData (object) or nullrequired
Any of:
owner.​idstringrequired
owner.​first_namestringrequired
owner.​last_namestringrequired
owner.​emailstringrequired
owner.​typestring(UserType)required
Enum"user""guest""tax_advisor""integration"
owner.​spaceobject(SpaceData)required
owner.​space.​idstringrequired
owner.​space.​namestringrequired
clientClientData (object) or nullrequired
Any of:
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
companiesArray of objects(CompanyData)
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
created_atstring(date-time)required
updated_atstring or null(date-time)required
deleted_atstring or null(date-time)required
contact_companyobject(ContactCompanyPivotData)

Added included via relationship (contact -> companies or company -> contacts)

{
  "id": "string",
  "external_id": "string",
  "external_origin": "string",
  "gender": "string",
  "first_name": "string",
  "last_name": "string",
  "title": "string",
  "title_suffix": "string",
  "position": "string",
  "locale": "string",
  "birthday": "2019-08-24",
  "fax": "string",
  "telephone": "string",
  "telephone_private": "string",
  "mobile": "string",
  "mobile_private": "string",
  "email": "user@example.com",
  "email_private": "user@example.com",
  "address_street": "string",
  "address_house": "string",
  "address_street2": "string",
  "address_zip": "string",
  "address_state": "string",
  "address_town": "string",
  "address_country": {
    "id": "string",
    "name": "string",
    "code": "string"
  },
  "owner": {
    "id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "type": "user",
    "space": { … }
  },
  "client": {
    "id": "string",
    "external_id": "string",
    "external_origin": "string",
    "name": "string",
    "shortcode": "string",
    "primary_contact": { … },
    "origin_space": { … }
  },
  "companies": [
    { … }
  ],
  "custom_fields": "['custom_field_1' => 'value', 'custom_field_2' => true]",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "deleted_at": "2019-08-24T14:15:22Z",
  "contact_company": {
    "position": "string"
  }
}

CountryData

idstringrequired
namestringrequired
codestring(ISO 3166-1 alpha-2)required
{
  "id": "string",
  "name": "string",
  "code": "string"
}

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

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

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"
}