Create a company

Users
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Clients
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Projects
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Tasks
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

OperationsWebhooks

Task Comments
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

OperationsWebhooks

Efforts
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Contacts
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Companies
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

OperationsWebhooks

List all companies

Request

Required scopes: contact-data:read

Security

http or oauth2

Query

sortstring

Available sorts are company_name, updated_at, created_at, custom_fields.<alias>.
You can sort by multiple options by separating them with a comma. To sort in descending order, use - sign in front of the sort, for example: -title.

Example: sort=sort=-created_at,title

includestring

Available includes are contacts. You can include multiple options by separating them with a comma.

page[size]integer

The number of results that will be returned per page.

Default 30

page[cursor]string

The cursor to start the pagination from.

filterstring

Allowed filter fields (with allowed operators):

Field	Type	Operators
`archived`	`enum: with, only, without`	eq
`company_name`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`tax_uid`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`iban`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`bic`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`phone`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`fax`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`email`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`email_general`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`homepage`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`invoices_by_post`	`boolean`	eq, ne, neq, isnull, isnotnull, notnull
`invoices_by_email`	`boolean`	eq, ne, neq, isnull, isnotnull, notnull
`business_field.id`	`id`	eq, ne, neq, in, nin, notin, isnull, isnotnull, notnull
`business_field.name`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`person_attention_to`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`address_invoice_title`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`address_invoice_street`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`address_invoice_street2`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`address_invoice_house`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`address_invoice_zip`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`address_invoice_state`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`address_invoice_town`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`address_invoice_country.name`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`address_invoice_is_delivery`	`bool`	eq, ne, neq, isnull, isnotnull, notnull
`delivery_person_attention_to`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`address_delivery_title`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`address_delivery_street`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`address_delivery_street2`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`address_delivery_house`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`address_delivery_zip`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`address_delivery_state`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`address_delivery_town`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`address_delivery_country.name`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`client.id`	`id`	eq, ne, neq, in, nin, notin, isnull, isnotnull, notnull
`client.name`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`client.shortcode`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`client.external_id`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`client.external_origin`	`string`	in, nin, notin, eq, ne, neq, contains, like, startswith, endswith, isnull, isnotnull, notnull
`created_at`	`date`	eq, ne, neq, lt, lte, le, gt, gte, ge, in, nin, notin, isnull, isnotnull, notnull
`updated_at`	`date`	eq, ne, neq, lt, lte, le, gt, gte, ge, in, nin, notin, isnull, isnotnull, notnull
`contacts`	`Relation` - id (id) - external_id (string) - external_origin (string) - first_name (string) - last_name (string) - birthday (date) - email (string) - email_private (string) - mobile (string) - mobile_private (string) - telephone (string) - telephone_private (string)	any, none, count, all
`tags`	`Relation` - id (id) - title (string)	any, none, count, all
`custom_fields.*` — see Custom fields below	`custom`	eq, ne, neq, lt, lte, le, gt, gte, ge, in, nin, notin, contains, like, startswith, endswith, isnull, isnotnull, notnull

Filtering expression. Accepts either JSON (array/tree of conditions) or a readable string DSL.

You can check the full syntax at Docs Filtering section.

Special values:

me.id — current authenticated user id (usable on fields of type id). Example: id eq me.id
now — current date-time. Example: dueOn lt now
sow/eow — start/end of week. Examples: dueOn gt sow, dueOn lt eow
som/eom — start/end of month. Examples: dueOn gt som, dueOn lt eom
today — special date for today; with eq it expands to the whole day range. Example: dueOn eq today
today±Nd — relative day offset. Examples: today-30d, today+5d.

Custom fields: when enabled, you can filter by custom_fields.<slug>. Example: custom_fields.my_flag eq 'yes' or custom_fields.score gte 10. Supported ops depend on the custom field type (eq, ne, in, nin, contains, startswith, endswith, isnull, isnotnull, and comparisons for numeric/date types).

Example: filter=title contains "Acme" and (created_at >= "2024-01-01" or client.name contains "Corp")

curl -i -X GET \
  'https://api.kanbert.com/api/v1/companies?sort=sort%3D-created_at%2Ctitle&include=string&page%5Bsize%5D=30&page%5Bcursor%5D=string&filter=title+contains+%22Acme%22+and+%28created_at+%3E%3D+%222024-01-01%22+or+client.name+contains+%22Corp%22%29' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

The cursor paginated collection of CompanyData

Bodyapplication/json

dataArray of objects(CompanyData)required

The list of items

data[].idstringrequired

data[].external_idstring or nullrequired

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

data[].external_originstring or nullrequired

If originated from external system origin is added

data[].vendor_identifierstring or nullrequired

data[].company_namestring or nullrequired

data[].localestring or nullrequired

data[].tax_uidstring or nullrequired

data[].taxation_enabledbooleanrequired

Can be used to indicate reverse charge ie

data[].ibanstring or nullrequired

data[].bicstring or nullrequired

data[].emailstring or nullrequired

data[].email_generalstring or nullrequired

data[].phonestring or nullrequired

data[].faxstring or nullrequired

data[].homepagestring or nullrequired

data[].invoices_by_postbooleanrequired

Default false

data[].invoices_by_emailbooleanrequired

Default false

data[].business_fieldBusinessFieldData (object) or nullrequired

Any of:

data[].business_field.idstringrequired

data[].business_field.namestringrequired

data[].company_sizeTagData (object) or nullrequired

Any of:

data[].company_size.idstringrequired

data[].company_size.titlestringrequired

data[].company_revenueTagData (object) or nullrequired

Any of:

data[].company_revenue.idstringrequired

data[].company_revenue.titlestringrequired

data[].person_attention_tostring or nullrequired

data[].address_invoice_titlestring or nullrequired

data[].address_invoice_streetstring or nullrequired

data[].address_invoice_housestring or nullrequired

data[].address_invoice_street2string or nullrequired

data[].address_invoice_zipstring or nullrequired

data[].address_invoice_statestring or nullrequired

data[].address_invoice_townstring or nullrequired

data[].address_invoice_countryCountryData (object) or nullrequired

Any of:

data[].address_invoice_country.idstringrequired

data[].address_invoice_country.namestringrequired

data[].address_invoice_country.codestring(ISO 3166-1 alpha-2)required

data[].address_invoice_is_deliverybooleanrequired

data[].delivery_person_attention_tostring or nullrequired

data[].address_delivery_titlestring or nullrequired

data[].address_delivery_streetstring or nullrequired

data[].address_delivery_housestring or nullrequired

data[].address_delivery_street2string or nullrequired

data[].address_delivery_zipstring or nullrequired

data[].address_delivery_statestring or nullrequired

data[].address_delivery_townstring or nullrequired

data[].address_delivery_countryCountryData (object) or nullrequired

Any of:

data[].address_delivery_country.idstringrequired

data[].address_delivery_country.namestringrequired

data[].address_delivery_country.codestring(ISO 3166-1 alpha-2)required

data[].clientClientData (object) or nullrequired

Any of:

data[].client.idstringrequired

data[].client.external_idstring or nullrequired

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

data[].client.external_originstring or nullrequired

If originated from external system origin is added

data[].client.namestringrequired

data[].client.shortcodestring or nullrequired

data[].client.primary_contactUserData (object) or nullrequired

Any of:

data[].client.primary_contact.idstringrequired

data[].client.primary_contact.first_namestringrequired

data[].client.primary_contact.last_namestringrequired

data[].client.primary_contact.emailstringrequired

data[].client.primary_contact.typestring(UserType)required

Enum"user""guest""tax_advisor""integration"

data[].client.primary_contact.spaceobject(SpaceData)required

data[].client.primary_contact.space.idstringrequired

data[].client.primary_contact.space.namestringrequired

data[].client.origin_spaceSpaceData (object) or nullrequired

Any of:

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

data[].client.origin_space.idstringrequired

data[].client.origin_space.namestringrequired

data[].tagsArray of objects(TagData)

data[].contactsArray of objects(ContactData)

data[].custom_fieldsobjectrequired

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

data[].custom_fields.property name*string or boolean or integer or nulladditional property

Any of:

string

data[].created_atstring(date-time)required

data[].updated_atstring or null(date-time)required

data[].deleted_atstring or null(date-time)required

data[].contact_companyobject(ContactCompanyPivotData)

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

linksArray of stringsrequired

metaobjectrequired

meta.pathstring or nullrequired

Base path for paginator generated URLs.

meta.per_pageintegerrequired

Number of items shown per page.

meta.next_cursorstring or nullrequired

meta.next_cursor_urlstring or nullrequired

meta.prev_cursorstring or nullrequired

meta.prev_cursor_urlstring or nullrequired

Response

application/json

{
  "data": [
    { … }
  ],
  "links": [
    "string"
  ],
  "meta": {
    "path": "string",
    "per_page": 0,
    "next_cursor": "string",
    "next_cursor_url": "string",
    "prev_cursor": "string",
    "prev_cursor_url": "string"
  }
}

Create a company

Request

Required scopes: contact-data:write

Security

http or oauth2

Bodyapplication/jsonrequired

external_idstring or null<= 255 characters

Can be used to add an identifier from an external system, must be unique within integration (integration's slug)

external_originstring<= 255 characters

If not set, integration's slug will be used as default

vendor_identifierstring or null<= 255 characters

company_namestring<= 255 charactersrequired

localestring or null<= 255 characters

tax_uidstring or null<= 255 characters

taxationboolean

ibanstring or null<= 255 characters

bicstring or null<= 255 characters

faxstring or null<= 255 characters

phonestring or null<= 255 characters

homepagestring or null<= 255 characters

emailstring or null<= 255 characters

Can be comma separated list of emails

email_generalstring or null(email)<= 255 characters

invoice_by_postboolean

invoices_by_emailboolean

person_attention_tostring or null<= 255 characters

address_invoice_titlestring or null<= 255 characters

address_invoice_streetstring or null<= 255 characters

address_invoice_street2string or null<= 255 characters

address_invoice_housestring or null<= 255 characters

address_invoice_zipstring or null<= 255 characters

address_invoice_statestring or null<= 255 characters

address_invoice_townstring or null<= 255 characters

address_invoice_is_deliveryboolean

address_invoice_countrystring

Format: ISO 3166-1 alpha-2 / ISO 3166-1 alpha-3 / ISO-3166-1 numeric / Name

You can use this field to associate a contact with a specific country. We try to find the corresponding country based on the provided value. If country code/name is valid but not created yet, it will be created. If country is not valid, the space's default country will be used.

Will be ignored if address_invoice_country_id is set.

address_invoice_country_idstring or null(CountryData)

You can use this field to associate a contact with a specific country already present in the system.

delivery_person_attention_tostring or null<= 255 characters

address_delivery_titlestring or null<= 255 characters

address_delivery_streetstring or null<= 255 characters

address_delivery_street2string or null<= 255 characters

address_delivery_housestring or null<= 255 characters

address_delivery_zipstring or null<= 255 characters

address_delivery_statestring or null<= 255 characters

address_delivery_townstring or null<= 255 characters

address_delivery_countrystring

Format: ISO 3166-1 alpha-2 / ISO 3166-1 alpha-3 / ISO-3166-1 numeric / Name

You can use this field to associate a contact with a specific country. We try to find the corresponding country based on the provided value. If country code/name is valid but not created yet, it will be created. If country is not valid, the space's default country will be used.

Will be ignored if address_delivery_country_id is set.

address_delivery_country_idstring or null(CountryData)

You can use this field to associate a contact with a specific country already present in the system.

client_idstring or null(ClientData)

business_fieldstring or null

If field not exists, a new one will be created

company_sizestring or null

company_revenuestring or null

tagsArray of strings

custom_fieldsArray of strings

Example: "{<slug>: <value>}"

curl -i -X POST \
  https://api.kanbert.com/api/v1/companies \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "external_id": "string",
    "external_origin": "string",
    "vendor_identifier": "string",
    "company_name": "string",
    "locale": "string",
    "tax_uid": "string",
    "taxation": true,
    "iban": "string",
    "bic": "string",
    "fax": "string",
    "phone": "string",
    "homepage": "string",
    "email": "string",
    "email_general": "user@example.com",
    "invoice_by_post": true,
    "invoices_by_email": true,
    "person_attention_to": "string",
    "address_invoice_title": "string",
    "address_invoice_street": "string",
    "address_invoice_street2": "string",
    "address_invoice_house": "string",
    "address_invoice_zip": "string",
    "address_invoice_state": "string",
    "address_invoice_town": "string",
    "address_invoice_is_delivery": true,
    "address_invoice_country": "string",
    "address_invoice_country_id": "string",
    "delivery_person_attention_to": "string",
    "address_delivery_title": "string",
    "address_delivery_street": "string",
    "address_delivery_street2": "string",
    "address_delivery_house": "string",
    "address_delivery_zip": "string",
    "address_delivery_state": "string",
    "address_delivery_town": "string",
    "address_delivery_country": "string",
    "address_delivery_country_id": "string",
    "client_id": "string",
    "business_field": "string",
    "company_size": "string",
    "company_revenue": "string",
    "tags": [
      "string"
    ],
    "custom_fields": "{<slug>: <value>}"
  }'

Responses

CompanyData

Bodyapplication/json

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

vendor_identifierstring or nullrequired

company_namestring or nullrequired

localestring or nullrequired

tax_uidstring or nullrequired

taxation_enabledbooleanrequired

Can be used to indicate reverse charge ie

ibanstring or nullrequired

bicstring or nullrequired

emailstring or nullrequired

email_generalstring or nullrequired

phonestring or nullrequired

faxstring or nullrequired

homepagestring or nullrequired

invoices_by_postbooleanrequired

Default false

invoices_by_emailbooleanrequired

Default false

business_fieldBusinessFieldData (object) or nullrequired

Any of:

business_field.idstringrequired

business_field.namestringrequired

company_sizeTagData (object) or nullrequired

Any of:

company_size.idstringrequired

company_size.titlestringrequired

company_revenueTagData (object) or nullrequired

Any of:

company_revenue.idstringrequired

company_revenue.titlestringrequired

person_attention_tostring or nullrequired

address_invoice_titlestring or nullrequired

address_invoice_streetstring or nullrequired

address_invoice_housestring or nullrequired

address_invoice_street2string or nullrequired

address_invoice_zipstring or nullrequired

address_invoice_statestring or nullrequired

address_invoice_townstring or nullrequired

address_invoice_countryCountryData (object) or nullrequired

Any of:

address_invoice_country.idstringrequired

address_invoice_country.namestringrequired

address_invoice_country.codestring(ISO 3166-1 alpha-2)required

address_invoice_is_deliverybooleanrequired

delivery_person_attention_tostring or nullrequired

address_delivery_titlestring or nullrequired

address_delivery_streetstring or nullrequired

address_delivery_housestring or nullrequired

address_delivery_street2string or nullrequired

address_delivery_zipstring or nullrequired

address_delivery_statestring or nullrequired

address_delivery_townstring or nullrequired

address_delivery_countryCountryData (object) or nullrequired

Any of:

address_delivery_country.idstringrequired

address_delivery_country.namestringrequired

address_delivery_country.codestring(ISO 3166-1 alpha-2)required

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

tagsArray of objects(TagData)

contactsArray of objects(ContactData)

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)

Response

application/json

{
  "id": "string",
  "external_id": "string",
  "external_origin": "string",
  "vendor_identifier": "string",
  "company_name": "string",
  "locale": "string",
  "tax_uid": "string",
  "taxation_enabled": true,
  "iban": "string",
  "bic": "string",
  "email": "string",
  "email_general": "string",
  "phone": "string",
  "fax": "string",
  "homepage": "string",
  "invoices_by_post": false,
  "invoices_by_email": false,
  "business_field": {
    "id": "string",
    "name": "string"
  },
  "company_size": {
    "id": "string",
    "title": "string"
  },
  "company_revenue": {
    "id": "string",
    "title": "string"
  },
  "person_attention_to": "string",
  "address_invoice_title": "string",
  "address_invoice_street": "string",
  "address_invoice_house": "string",
  "address_invoice_street2": "string",
  "address_invoice_zip": "string",
  "address_invoice_state": "string",
  "address_invoice_town": "string",
  "address_invoice_country": {
    "id": "string",
    "name": "string",
    "code": "string"
  },
  "address_invoice_is_delivery": true,
  "delivery_person_attention_to": "string",
  "address_delivery_title": "string",
  "address_delivery_street": "string",
  "address_delivery_house": "string",
  "address_delivery_street2": "string",
  "address_delivery_zip": "string",
  "address_delivery_state": "string",
  "address_delivery_town": "string",
  "address_delivery_country": {
    "id": "string",
    "name": "string",
    "code": "string"
  },
  "client": {
    "id": "string",
    "external_id": "string",
    "external_origin": "string",
    "name": "string",
    "shortcode": "string",
    "primary_contact": { … },
    "origin_space": { … }
  },
  "tags": [
    { … }
  ],
  "contacts": [
    { … }
  ],
  "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"
  }
}

Retrieve a company

Request

Required scopes: contact-data:read

Security

http or oauth2

Path

idstringrequired

Query

find_bystring

The field to search by

Default "id"

Enum"id""external_id"

originstring

Used if find_by=external_id by default it will use the integration slug

includestring

Available includes are contacts. You can include multiple options by separating them with a comma.

curl -i -X GET \
  'https://api.kanbert.com/api/v1/companies/{id}?find_by=id&origin=string&include=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

CompanyData

Bodyapplication/json

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

vendor_identifierstring or nullrequired

company_namestring or nullrequired

localestring or nullrequired

tax_uidstring or nullrequired

taxation_enabledbooleanrequired

Can be used to indicate reverse charge ie

ibanstring or nullrequired

bicstring or nullrequired

emailstring or nullrequired

email_generalstring or nullrequired

phonestring or nullrequired

faxstring or nullrequired

homepagestring or nullrequired

invoices_by_postbooleanrequired

Default false

invoices_by_emailbooleanrequired

Default false

business_fieldBusinessFieldData (object) or nullrequired

Any of:

business_field.idstringrequired

business_field.namestringrequired

company_sizeTagData (object) or nullrequired

Any of:

company_size.idstringrequired

company_size.titlestringrequired

company_revenueTagData (object) or nullrequired

Any of:

company_revenue.idstringrequired

company_revenue.titlestringrequired

person_attention_tostring or nullrequired

address_invoice_titlestring or nullrequired

address_invoice_streetstring or nullrequired

address_invoice_housestring or nullrequired

address_invoice_street2string or nullrequired

address_invoice_zipstring or nullrequired

address_invoice_statestring or nullrequired

address_invoice_townstring or nullrequired

address_invoice_countryCountryData (object) or nullrequired

Any of:

address_invoice_country.idstringrequired

address_invoice_country.namestringrequired

address_invoice_country.codestring(ISO 3166-1 alpha-2)required

address_invoice_is_deliverybooleanrequired

delivery_person_attention_tostring or nullrequired

address_delivery_titlestring or nullrequired

address_delivery_streetstring or nullrequired

address_delivery_housestring or nullrequired

address_delivery_street2string or nullrequired

address_delivery_zipstring or nullrequired

address_delivery_statestring or nullrequired

address_delivery_townstring or nullrequired

address_delivery_countryCountryData (object) or nullrequired

Any of:

address_delivery_country.idstringrequired

address_delivery_country.namestringrequired

address_delivery_country.codestring(ISO 3166-1 alpha-2)required

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

tagsArray of objects(TagData)

contactsArray of objects(ContactData)

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)

Response

application/json

{
  "id": "string",
  "external_id": "string",
  "external_origin": "string",
  "vendor_identifier": "string",
  "company_name": "string",
  "locale": "string",
  "tax_uid": "string",
  "taxation_enabled": true,
  "iban": "string",
  "bic": "string",
  "email": "string",
  "email_general": "string",
  "phone": "string",
  "fax": "string",
  "homepage": "string",
  "invoices_by_post": false,
  "invoices_by_email": false,
  "business_field": {
    "id": "string",
    "name": "string"
  },
  "company_size": {
    "id": "string",
    "title": "string"
  },
  "company_revenue": {
    "id": "string",
    "title": "string"
  },
  "person_attention_to": "string",
  "address_invoice_title": "string",
  "address_invoice_street": "string",
  "address_invoice_house": "string",
  "address_invoice_street2": "string",
  "address_invoice_zip": "string",
  "address_invoice_state": "string",
  "address_invoice_town": "string",
  "address_invoice_country": {
    "id": "string",
    "name": "string",
    "code": "string"
  },
  "address_invoice_is_delivery": true,
  "delivery_person_attention_to": "string",
  "address_delivery_title": "string",
  "address_delivery_street": "string",
  "address_delivery_house": "string",
  "address_delivery_street2": "string",
  "address_delivery_zip": "string",
  "address_delivery_state": "string",
  "address_delivery_town": "string",
  "address_delivery_country": {
    "id": "string",
    "name": "string",
    "code": "string"
  },
  "client": {
    "id": "string",
    "external_id": "string",
    "external_origin": "string",
    "name": "string",
    "shortcode": "string",
    "primary_contact": { … },
    "origin_space": { … }
  },
  "tags": [
    { … }
  ],
  "contacts": [
    { … }
  ],
  "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"
  }
}

Update a company

Request

Required scopes: contact-data:write

To update external_id jump to Endpoint /companies/{id}/external-identifier

Security

http or oauth2

Path

idstringrequired

Query

find_bystring

The field to search by

Default "id"

Enum"id""external_id"

originstring

Used if find_by=external_id by default it will use the integration slug

Bodyapplication/json

vendor_identifierstring or null<= 255 characters

company_namestring or null<= 255 characters

localestring or null<= 255 characters

tax_uidstring or null<= 255 characters

taxationboolean

ibanstring or null<= 255 characters

bicstring or null<= 255 characters

faxstring or null<= 255 characters

phonestring or null<= 255 characters

homepagestring or null<= 255 characters

emailstring or null<= 255 characters

Can be comma separated list of emails

email_generalstring or null(email)<= 255 characters

invoice_by_postboolean

invoices_by_emailboolean

person_attention_tostring or null<= 255 characters

address_invoice_titlestring or null<= 255 characters

address_invoice_streetstring or null<= 255 characters

address_invoice_street2string or null<= 255 characters

address_invoice_housestring or null<= 255 characters

address_invoice_zipstring or null<= 255 characters

address_invoice_statestring or null<= 255 characters

address_invoice_townstring or null<= 255 characters

address_invoice_is_deliveryboolean

address_invoice_countrystring

Format: ISO 3166-1 alpha-2 / ISO 3166-1 alpha-3 / ISO-3166-1 numeric / Name

You can use this field to associate a contact with a specific country. We try to find the corresponding country based on the provided value. If country code/name is valid but not created yet, it will be created. If country is not valid, the space's default country will be used.

Will be ignored if address_invoice_country_id is set.

address_invoice_country_idstring or null(CountryData)

You can use this field to associate a contact with a specific country already present in the system.

delivery_person_attention_tostring or null<= 255 characters

address_delivery_titlestring or null<= 255 characters

address_delivery_streetstring or null<= 255 characters

address_delivery_street2string or null<= 255 characters

address_delivery_housestring or null<= 255 characters

address_delivery_zipstring or null<= 255 characters

address_delivery_statestring or null<= 255 characters

address_delivery_townstring or null<= 255 characters

address_delivery_countrystring

Format: ISO 3166-1 alpha-2 / ISO 3166-1 alpha-3 / ISO-3166-1 numeric / Name

You can use this field to associate a contact with a specific country. We try to find the corresponding country based on the provided value. If country code/name is valid but not created yet, it will be created. If country is not valid, the space's default country will be used.

Will be ignored if address_delivery_country_id is set.

address_delivery_country_idstring or null(CountryData)

You can use this field to associate a contact with a specific country already present in the system.

client_idstring or null(ClientData)

business_fieldstring or null

If field not exists, a new one will be created

company_sizestring or null

company_revenuestring or null

tagsArray of strings

custom_fieldsArray of strings

Example: "{<slug>: <value>}"

curl -i -X PATCH \
  'https://api.kanbert.com/api/v1/companies/{id}?find_by=id&origin=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "vendor_identifier": "string",
    "company_name": "string",
    "locale": "string",
    "tax_uid": "string",
    "taxation": true,
    "iban": "string",
    "bic": "string",
    "fax": "string",
    "phone": "string",
    "homepage": "string",
    "email": "string",
    "email_general": "user@example.com",
    "invoice_by_post": true,
    "invoices_by_email": true,
    "person_attention_to": "string",
    "address_invoice_title": "string",
    "address_invoice_street": "string",
    "address_invoice_street2": "string",
    "address_invoice_house": "string",
    "address_invoice_zip": "string",
    "address_invoice_state": "string",
    "address_invoice_town": "string",
    "address_invoice_is_delivery": true,
    "address_invoice_country": "string",
    "address_invoice_country_id": "string",
    "delivery_person_attention_to": "string",
    "address_delivery_title": "string",
    "address_delivery_street": "string",
    "address_delivery_street2": "string",
    "address_delivery_house": "string",
    "address_delivery_zip": "string",
    "address_delivery_state": "string",
    "address_delivery_town": "string",
    "address_delivery_country": "string",
    "address_delivery_country_id": "string",
    "client_id": "string",
    "business_field": "string",
    "company_size": "string",
    "company_revenue": "string",
    "tags": [
      "string"
    ],
    "custom_fields": "{<slug>: <value>}"
  }'

Responses

CompanyData

Bodyapplication/json

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

vendor_identifierstring or nullrequired

company_namestring or nullrequired

localestring or nullrequired

tax_uidstring or nullrequired

taxation_enabledbooleanrequired

Can be used to indicate reverse charge ie

ibanstring or nullrequired

bicstring or nullrequired

emailstring or nullrequired

email_generalstring or nullrequired

phonestring or nullrequired

faxstring or nullrequired

homepagestring or nullrequired

invoices_by_postbooleanrequired

Default false

invoices_by_emailbooleanrequired

Default false

business_fieldBusinessFieldData (object) or nullrequired

Any of:

business_field.idstringrequired

business_field.namestringrequired

company_sizeTagData (object) or nullrequired

Any of:

company_size.idstringrequired

company_size.titlestringrequired

company_revenueTagData (object) or nullrequired

Any of:

company_revenue.idstringrequired

company_revenue.titlestringrequired

person_attention_tostring or nullrequired

address_invoice_titlestring or nullrequired

address_invoice_streetstring or nullrequired

address_invoice_housestring or nullrequired

address_invoice_street2string or nullrequired

address_invoice_zipstring or nullrequired

address_invoice_statestring or nullrequired

address_invoice_townstring or nullrequired

address_invoice_countryCountryData (object) or nullrequired

Any of:

address_invoice_country.idstringrequired

address_invoice_country.namestringrequired

address_invoice_country.codestring(ISO 3166-1 alpha-2)required

address_invoice_is_deliverybooleanrequired

delivery_person_attention_tostring or nullrequired

address_delivery_titlestring or nullrequired

address_delivery_streetstring or nullrequired

address_delivery_housestring or nullrequired

address_delivery_street2string or nullrequired

address_delivery_zipstring or nullrequired

address_delivery_statestring or nullrequired

address_delivery_townstring or nullrequired

address_delivery_countryCountryData (object) or nullrequired

Any of:

address_delivery_country.idstringrequired

address_delivery_country.namestringrequired

address_delivery_country.codestring(ISO 3166-1 alpha-2)required

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

tagsArray of objects(TagData)

contactsArray of objects(ContactData)

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)

Response

application/json

{
  "id": "string",
  "external_id": "string",
  "external_origin": "string",
  "vendor_identifier": "string",
  "company_name": "string",
  "locale": "string",
  "tax_uid": "string",
  "taxation_enabled": true,
  "iban": "string",
  "bic": "string",
  "email": "string",
  "email_general": "string",
  "phone": "string",
  "fax": "string",
  "homepage": "string",
  "invoices_by_post": false,
  "invoices_by_email": false,
  "business_field": {
    "id": "string",
    "name": "string"
  },
  "company_size": {
    "id": "string",
    "title": "string"
  },
  "company_revenue": {
    "id": "string",
    "title": "string"
  },
  "person_attention_to": "string",
  "address_invoice_title": "string",
  "address_invoice_street": "string",
  "address_invoice_house": "string",
  "address_invoice_street2": "string",
  "address_invoice_zip": "string",
  "address_invoice_state": "string",
  "address_invoice_town": "string",
  "address_invoice_country": {
    "id": "string",
    "name": "string",
    "code": "string"
  },
  "address_invoice_is_delivery": true,
  "delivery_person_attention_to": "string",
  "address_delivery_title": "string",
  "address_delivery_street": "string",
  "address_delivery_house": "string",
  "address_delivery_street2": "string",
  "address_delivery_zip": "string",
  "address_delivery_state": "string",
  "address_delivery_town": "string",
  "address_delivery_country": {
    "id": "string",
    "name": "string",
    "code": "string"
  },
  "client": {
    "id": "string",
    "external_id": "string",
    "external_origin": "string",
    "name": "string",
    "shortcode": "string",
    "primary_contact": { … },
    "origin_space": { … }
  },
  "tags": [
    { … }
  ],
  "contacts": [
    { … }
  ],
  "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"
  }
}

Archive a company

Request

Required scopes: contact-data:write

Security

http or oauth2

Path

idstringrequired

Query

find_bystring

The field to search by

Default "id"

Enum"id""external_id"

originstring

Used if find_by=external_id by default it will use the integration slug

curl -i -X DELETE \
  'https://api.kanbert.com/api/v1/companies/{id}?find_by=id&origin=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json

messagestringrequired

Value"Company deleted successfully"

Response

application/json

{
  "message": "Company deleted successfully"
}

Update a companys external identifier

Request

Required scopes: contact-data:write

Can be used to force overwrite external_id

Security

http or oauth2

Path

idstringrequired

Query

find_bystring

The field to search by

Default "id"

Enum"id""external_id"

originstring

Used if find_by=external_id by default it will use the integration slug

Bodyapplication/json

external_idstring or null<= 255 characters

Can be used to add an identifier from an external system, must be unique within integration (integration slug)

external_originstring<= 255 characters

If not set, integration's slug will be used as default

curl -i -X PUT \
  'https://api.kanbert.com/api/v1/companies/{id}/external-identifier?find_by=id&origin=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "external_id": "string",
    "external_origin": "string"
  }'

Responses

CompanyData

Bodyapplication/json

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

vendor_identifierstring or nullrequired

company_namestring or nullrequired

localestring or nullrequired

tax_uidstring or nullrequired

taxation_enabledbooleanrequired

Can be used to indicate reverse charge ie

ibanstring or nullrequired

bicstring or nullrequired

emailstring or nullrequired

email_generalstring or nullrequired

phonestring or nullrequired

faxstring or nullrequired

homepagestring or nullrequired

invoices_by_postbooleanrequired

Default false

invoices_by_emailbooleanrequired

Default false

business_fieldBusinessFieldData (object) or nullrequired

Any of:

business_field.idstringrequired

business_field.namestringrequired

company_sizeTagData (object) or nullrequired

Any of:

company_size.idstringrequired

company_size.titlestringrequired

company_revenueTagData (object) or nullrequired

Any of:

company_revenue.idstringrequired

company_revenue.titlestringrequired

person_attention_tostring or nullrequired

address_invoice_titlestring or nullrequired

address_invoice_streetstring or nullrequired

address_invoice_housestring or nullrequired

address_invoice_street2string or nullrequired

address_invoice_zipstring or nullrequired

address_invoice_statestring or nullrequired

address_invoice_townstring or nullrequired

address_invoice_countryCountryData (object) or nullrequired

Any of:

address_invoice_country.idstringrequired

address_invoice_country.namestringrequired

address_invoice_country.codestring(ISO 3166-1 alpha-2)required

address_invoice_is_deliverybooleanrequired

delivery_person_attention_tostring or nullrequired

address_delivery_titlestring or nullrequired

address_delivery_streetstring or nullrequired

address_delivery_housestring or nullrequired

address_delivery_street2string or nullrequired

address_delivery_zipstring or nullrequired

address_delivery_statestring or nullrequired

address_delivery_townstring or nullrequired

address_delivery_countryCountryData (object) or nullrequired

Any of:

address_delivery_country.idstringrequired

address_delivery_country.namestringrequired

address_delivery_country.codestring(ISO 3166-1 alpha-2)required

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

tagsArray of objects(TagData)

contactsArray of objects(ContactData)

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)

Response

application/json

{
  "id": "string",
  "external_id": "string",
  "external_origin": "string",
  "vendor_identifier": "string",
  "company_name": "string",
  "locale": "string",
  "tax_uid": "string",
  "taxation_enabled": true,
  "iban": "string",
  "bic": "string",
  "email": "string",
  "email_general": "string",
  "phone": "string",
  "fax": "string",
  "homepage": "string",
  "invoices_by_post": false,
  "invoices_by_email": false,
  "business_field": {
    "id": "string",
    "name": "string"
  },
  "company_size": {
    "id": "string",
    "title": "string"
  },
  "company_revenue": {
    "id": "string",
    "title": "string"
  },
  "person_attention_to": "string",
  "address_invoice_title": "string",
  "address_invoice_street": "string",
  "address_invoice_house": "string",
  "address_invoice_street2": "string",
  "address_invoice_zip": "string",
  "address_invoice_state": "string",
  "address_invoice_town": "string",
  "address_invoice_country": {
    "id": "string",
    "name": "string",
    "code": "string"
  },
  "address_invoice_is_delivery": true,
  "delivery_person_attention_to": "string",
  "address_delivery_title": "string",
  "address_delivery_street": "string",
  "address_delivery_house": "string",
  "address_delivery_street2": "string",
  "address_delivery_zip": "string",
  "address_delivery_state": "string",
  "address_delivery_town": "string",
  "address_delivery_country": {
    "id": "string",
    "name": "string",
    "code": "string"
  },
  "client": {
    "id": "string",
    "external_id": "string",
    "external_origin": "string",
    "name": "string",
    "shortcode": "string",
    "primary_contact": { … },
    "origin_space": { … }
  },
  "tags": [
    { … }
  ],
  "contacts": [
    { … }
  ],
  "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"
  }
}

Restore a company

Request

Required scopes: contact-data:write

Security

http or oauth2

Path

idstringrequired

Query

find_bystring

The field to search by

Default "id"

Enum"id""external_id"

originstring

Used if find_by=external_id by default it will use the integration slug

curl -i -X POST \
  'https://api.kanbert.com/api/v1/companies/{id}/restore?find_by=id&origin=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

CompanyData

Bodyapplication/json

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

vendor_identifierstring or nullrequired

company_namestring or nullrequired

localestring or nullrequired

tax_uidstring or nullrequired

taxation_enabledbooleanrequired

Can be used to indicate reverse charge ie

ibanstring or nullrequired

bicstring or nullrequired

emailstring or nullrequired

email_generalstring or nullrequired

phonestring or nullrequired

faxstring or nullrequired

homepagestring or nullrequired

invoices_by_postbooleanrequired

Default false

invoices_by_emailbooleanrequired

Default false

business_fieldBusinessFieldData (object) or nullrequired

Any of:

business_field.idstringrequired

business_field.namestringrequired

company_sizeTagData (object) or nullrequired

Any of:

company_size.idstringrequired

company_size.titlestringrequired

company_revenueTagData (object) or nullrequired

Any of:

company_revenue.idstringrequired

company_revenue.titlestringrequired

person_attention_tostring or nullrequired

address_invoice_titlestring or nullrequired

address_invoice_streetstring or nullrequired

address_invoice_housestring or nullrequired

address_invoice_street2string or nullrequired

address_invoice_zipstring or nullrequired

address_invoice_statestring or nullrequired

address_invoice_townstring or nullrequired

address_invoice_countryCountryData (object) or nullrequired

Any of:

address_invoice_country.idstringrequired

address_invoice_country.namestringrequired

address_invoice_country.codestring(ISO 3166-1 alpha-2)required

address_invoice_is_deliverybooleanrequired

delivery_person_attention_tostring or nullrequired

address_delivery_titlestring or nullrequired

address_delivery_streetstring or nullrequired

address_delivery_housestring or nullrequired

address_delivery_street2string or nullrequired

address_delivery_zipstring or nullrequired

address_delivery_statestring or nullrequired

address_delivery_townstring or nullrequired

address_delivery_countryCountryData (object) or nullrequired

Any of:

address_delivery_country.idstringrequired

address_delivery_country.namestringrequired

address_delivery_country.codestring(ISO 3166-1 alpha-2)required

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

tagsArray of objects(TagData)

contactsArray of objects(ContactData)

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)

Response

application/json

{
  "id": "string",
  "external_id": "string",
  "external_origin": "string",
  "vendor_identifier": "string",
  "company_name": "string",
  "locale": "string",
  "tax_uid": "string",
  "taxation_enabled": true,
  "iban": "string",
  "bic": "string",
  "email": "string",
  "email_general": "string",
  "phone": "string",
  "fax": "string",
  "homepage": "string",
  "invoices_by_post": false,
  "invoices_by_email": false,
  "business_field": {
    "id": "string",
    "name": "string"
  },
  "company_size": {
    "id": "string",
    "title": "string"
  },
  "company_revenue": {
    "id": "string",
    "title": "string"
  },
  "person_attention_to": "string",
  "address_invoice_title": "string",
  "address_invoice_street": "string",
  "address_invoice_house": "string",
  "address_invoice_street2": "string",
  "address_invoice_zip": "string",
  "address_invoice_state": "string",
  "address_invoice_town": "string",
  "address_invoice_country": {
    "id": "string",
    "name": "string",
    "code": "string"
  },
  "address_invoice_is_delivery": true,
  "delivery_person_attention_to": "string",
  "address_delivery_title": "string",
  "address_delivery_street": "string",
  "address_delivery_house": "string",
  "address_delivery_street2": "string",
  "address_delivery_zip": "string",
  "address_delivery_state": "string",
  "address_delivery_town": "string",
  "address_delivery_country": {
    "id": "string",
    "name": "string",
    "code": "string"
  },
  "client": {
    "id": "string",
    "external_id": "string",
    "external_origin": "string",
    "name": "string",
    "shortcode": "string",
    "primary_contact": { … },
    "origin_space": { … }
  },
  "tags": [
    { … }
  ],
  "contacts": [
    { … }
  ],
  "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"
  }
}

Company createdWebhook

Request

company:create - A new company was created

Security

http or oauth2

Bodyapplication/json

eventstring

the event identifier

Example: "company:create"

resourceobject

triggered_byobject(UserData)

dataobject(CompanyData)

application/json

{
  "event": "company:create",
  "resource": {
    "type": "company",
    "id": "string"
  },
  "triggered_by": {
    "id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "type": "user",
    "space": { … }
  },
  "data": {
    "id": "string",
    "external_id": "string",
    "external_origin": "string",
    "vendor_identifier": "string",
    "company_name": "string",
    "locale": "string",
    "tax_uid": "string",
    "taxation_enabled": true,
    "iban": "string",
    "bic": "string",
    "email": "string",
    "email_general": "string",
    "phone": "string",
    "fax": "string",
    "homepage": "string",
    "invoices_by_post": false,
    "invoices_by_email": false,
    "business_field": { … },
    "company_size": { … },
    "company_revenue": { … },
    "person_attention_to": "string",
    "address_invoice_title": "string",
    "address_invoice_street": "string",
    "address_invoice_house": "string",
    "address_invoice_street2": "string",
    "address_invoice_zip": "string",
    "address_invoice_state": "string",
    "address_invoice_town": "string",
    "address_invoice_country": { … },
    "address_invoice_is_delivery": true,
    "delivery_person_attention_to": "string",
    "address_delivery_title": "string",
    "address_delivery_street": "string",
    "address_delivery_house": "string",
    "address_delivery_street2": "string",
    "address_delivery_zip": "string",
    "address_delivery_state": "string",
    "address_delivery_town": "string",
    "address_delivery_country": { … },
    "client": { … },
    "tags": [ … ],
    "contacts": [ … ],
    "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": { … }
  }
}

Responses

Return a 200 within 10 seconds to indicate a that the data was received successfully. Otherwise it will try 2 more times.

Company updatedWebhook

Request

company:update A company was updated

Security

http or oauth2

Bodyapplication/json

eventstring

the event identifier

Example: "company:update"

resourceobject

triggered_byobject(UserData)

dataobject(CompanyData)

application/json

{
  "event": "company:update",
  "resource": {
    "type": "company",
    "id": "string"
  },
  "triggered_by": {
    "id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "type": "user",
    "space": { … }
  },
  "data": {
    "id": "string",
    "external_id": "string",
    "external_origin": "string",
    "vendor_identifier": "string",
    "company_name": "string",
    "locale": "string",
    "tax_uid": "string",
    "taxation_enabled": true,
    "iban": "string",
    "bic": "string",
    "email": "string",
    "email_general": "string",
    "phone": "string",
    "fax": "string",
    "homepage": "string",
    "invoices_by_post": false,
    "invoices_by_email": false,
    "business_field": { … },
    "company_size": { … },
    "company_revenue": { … },
    "person_attention_to": "string",
    "address_invoice_title": "string",
    "address_invoice_street": "string",
    "address_invoice_house": "string",
    "address_invoice_street2": "string",
    "address_invoice_zip": "string",
    "address_invoice_state": "string",
    "address_invoice_town": "string",
    "address_invoice_country": { … },
    "address_invoice_is_delivery": true,
    "delivery_person_attention_to": "string",
    "address_delivery_title": "string",
    "address_delivery_street": "string",
    "address_delivery_house": "string",
    "address_delivery_street2": "string",
    "address_delivery_zip": "string",
    "address_delivery_state": "string",
    "address_delivery_town": "string",
    "address_delivery_country": { … },
    "client": { … },
    "tags": [ … ],
    "contacts": [ … ],
    "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": { … }
  }
}

Responses

Return a 200 within 10 seconds to indicate a that the data was received successfully. Otherwise it will try 2 more times.

Company deletedWebhook

Request

company:delete - A company was deleted

Security

http or oauth2

Bodyapplication/json

eventstring

the event identifier

Example: "company:delete"

resourceobject

triggered_byobject(UserData)

dataobject(CompanyData)

application/json

{
  "event": "company:delete",
  "resource": {
    "type": "company",
    "id": "string"
  },
  "triggered_by": {
    "id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "string",
    "type": "user",
    "space": { … }
  },
  "data": {
    "id": "string",
    "external_id": "string",
    "external_origin": "string",
    "vendor_identifier": "string",
    "company_name": "string",
    "locale": "string",
    "tax_uid": "string",
    "taxation_enabled": true,
    "iban": "string",
    "bic": "string",
    "email": "string",
    "email_general": "string",
    "phone": "string",
    "fax": "string",
    "homepage": "string",
    "invoices_by_post": false,
    "invoices_by_email": false,
    "business_field": { … },
    "company_size": { … },
    "company_revenue": { … },
    "person_attention_to": "string",
    "address_invoice_title": "string",
    "address_invoice_street": "string",
    "address_invoice_house": "string",
    "address_invoice_street2": "string",
    "address_invoice_zip": "string",
    "address_invoice_state": "string",
    "address_invoice_town": "string",
    "address_invoice_country": { … },
    "address_invoice_is_delivery": true,
    "delivery_person_attention_to": "string",
    "address_delivery_title": "string",
    "address_delivery_street": "string",
    "address_delivery_house": "string",
    "address_delivery_street2": "string",
    "address_delivery_zip": "string",
    "address_delivery_state": "string",
    "address_delivery_town": "string",
    "address_delivery_country": { … },
    "client": { … },
    "tags": [ … ],
    "contacts": [ … ],
    "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": { … }
  }
}

Responses

Return a 200 within 10 seconds to indicate a that the data was received successfully. Otherwise it will try 2 more times.

Offers
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Outgoing Invoices
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Payments
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Usergroups & Teams
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Settings
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Integration
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Files
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Custom Fields
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Webhook Management
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Operations

Schemas
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Schemas

Kanbert (v1)CopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

UsersCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

ClientsCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

ProjectsCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

TasksCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

Task CommentsCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

EffortsCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

ContactsCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

CompaniesCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

List all companies

Request

Responses

Was this helpful?

Create a company

Request

Responses

Was this helpful?

Retrieve a company

Request

Responses

Was this helpful?

Update a company

Request

Responses

Was this helpful?

Archive a company

Request

Responses

Was this helpful?

Update a companys external identifier

Request

Responses

Was this helpful?

Restore a company

Request

Responses

Was this helpful?

Company createdWebhook

RequestExpand all

Responses

Was this helpful?

Company updatedWebhook

RequestExpand all

Responses

Was this helpful?

Company deletedWebhook

RequestExpand all

Responses

Was this helpful?

OffersCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

Outgoing InvoicesCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

PaymentsCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

Usergroups & TeamsCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

SettingsCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

IntegrationCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

FilesCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

Custom FieldsCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

Webhook ManagementCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

SchemasCopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

Kanbert (v1)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Users
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Clients
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Projects
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Tasks
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Task Comments
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Efforts
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Contacts
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Companies
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Request

Request

Request

Offers
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Outgoing Invoices
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Payments
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Usergroups & Teams
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Settings
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Integration
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Files
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Custom Fields
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Webhook Management
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Schemas
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude