Contractors.es API Docs (1.0.41)

Download OpenAPI specification:

Sample code:

  • JavaScript - open test.html in a browser.

  • NodeJS - Requires installed nodejs/npm.

    npm install
    npm run test
    
  • PHP 8 - Requires installed composer.

    composer require contractors-es/api
    
  • Python 3

    python test.py
    
  • n8n community node Install the community node package in your n8n instance - go to settings, community nodes and add:

    @contractors-es/n8n-nodes-contractors-es
    

    Add Contractors.es API credentials in n8n and create a workflow with the Contractors.es node.

All datetimes are handled in UTC. Datetimes returned by the API include time in UTC, and any datetime you pass is treated as UTC. If you provide an ISO-8601 datetime (YYYY-MM-DDTHH:MM+TZ:00), it will be converted to UTC.

Country Api

API documentation for Country Api

Get a list of countries

Authorizations:
BearerAuth
query Parameters
page
integer
Default: 1
limit
integer
Default: 20

Responses

Response samples

Content type
application/json
{}

Get country

Authorizations:
BearerAuth
path Parameters
country
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

State Api

API documentation for State Api

Get a list of states

Authorizations:
BearerAuth
path Parameters
country
required
integer
query Parameters
page
integer
Default: 1
limit
integer
Default: 20

Responses

Response samples

Content type
application/json
{}

Get state

Authorizations:
BearerAuth
path Parameters
country
required
integer
state
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Associate state with country

Authorizations:
BearerAuth
path Parameters
country
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Companies Webhook Api

API documentation for Companies Webhook Api

Create webhook

Authorizations:
BearerAuth
Request Body schema: application/json
url
string
event
any
Enum: "created" "updated" "deleted" "restored" "saved" "all"
Array of Array of arrays or strings or null
Default: null
columns_changed
Array of strings or null
Default: null
description
string or null
active
integer

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "event": "created",
  • "payload": null,
  • "columns_changed": null,
  • "description": "string",
  • "active": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of webhooks

Authorizations:
BearerAuth
query Parameters
page
integer
Default: 1
limit
integer
Default: 20

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get webhook

Authorizations:
BearerAuth
path Parameters
webhook
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update webhook

Authorizations:
BearerAuth
path Parameters
webhook
required
integer
Request Body schema: application/json
url
string
event
any
Enum: "created" "updated" "deleted" "restored" "saved" "all"
Array of Array of arrays or strings or null
Default: null
columns_changed
Array of strings or null
Default: null
description
string or null
active
integer

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "event": "created",
  • "payload": null,
  • "columns_changed": null,
  • "description": "string",
  • "active": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete webhook

Authorizations:
BearerAuth
path Parameters
webhook
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Company Api

API documentation for Company Api

Create company

Authorizations:
BearerAuth
Request Body schema: application/json
company_name
string
short_name
string or null
phone
string or null
fax
string or null
email
string or null
web_address
string or null
address_1
string or null
address_2
string or null
city
string or null
country_id
integer
state_id
integer or null
postcode
string or null
tax_id
string or null
memo
string or null
default_hour_rate
any
default_hour_rate_currency
string or null
salary_custom_percentages
integer
salary_secondary_percentage
any
overtime_primary_percentage
any
overtime_secondary_percentage
any
permission
integer
Default: 0
Enum: 1 2 3

1 - public, 2 - public (read-only), 3 - private

external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "company_name": "string",
  • "short_name": "string",
  • "phone": "string",
  • "fax": "string",
  • "email": "string",
  • "web_address": "string",
  • "address_1": "string",
  • "address_2": "string",
  • "city": "string",
  • "country_id": 0,
  • "state_id": 0,
  • "postcode": "string",
  • "tax_id": "string",
  • "memo": "string",
  • "default_hour_rate": null,
  • "default_hour_rate_currency": "string",
  • "salary_custom_percentages": 0,
  • "salary_secondary_percentage": null,
  • "overtime_primary_percentage": null,
  • "overtime_secondary_percentage": null,
  • "permission": 1,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of companies

Authorizations:
BearerAuth
query Parameters
with_trashed
boolean
only_trashed
boolean
page
integer
Default: 1
limit
integer
Default: 20

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get company

Authorizations:
BearerAuth
path Parameters
company
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update company

Authorizations:
BearerAuth
path Parameters
company
required
integer
Request Body schema: application/json
company_name
string
short_name
string or null
phone
string or null
fax
string or null
email
string or null
web_address
string or null
address_1
string or null
address_2
string or null
city
string or null
country_id
integer
state_id
integer or null
postcode
string or null
tax_id
string or null
memo
string or null
default_hour_rate
any
default_hour_rate_currency
string or null
salary_custom_percentages
integer
salary_secondary_percentage
any
overtime_primary_percentage
any
overtime_secondary_percentage
any
permission
integer
Default: 0
Enum: 1 2 3

1 - public, 2 - public (read-only), 3 - private

external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "company_name": "string",
  • "short_name": "string",
  • "phone": "string",
  • "fax": "string",
  • "email": "string",
  • "web_address": "string",
  • "address_1": "string",
  • "address_2": "string",
  • "city": "string",
  • "country_id": 0,
  • "state_id": 0,
  • "postcode": "string",
  • "tax_id": "string",
  • "memo": "string",
  • "default_hour_rate": null,
  • "default_hour_rate_currency": "string",
  • "salary_custom_percentages": 0,
  • "salary_secondary_percentage": null,
  • "overtime_primary_percentage": null,
  • "overtime_secondary_percentage": null,
  • "permission": 1,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete company

Authorizations:
BearerAuth
path Parameters
company
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore company

Authorizations:
BearerAuth
path Parameters
company
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of companies

Authorizations:
BearerAuth
Request Body schema: application/json
Array of objects (Company)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of companies

Authorizations:
BearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of companies

Authorizations:
BearerAuth
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of companies

Authorizations:
BearerAuth
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Company Notes Relation Api

API documentation for Company Notes Relation Api

Create note

Authorizations:
BearerAuth
path Parameters
company
required
integer
Request Body schema: application/json
title
string
note
any
files
Array of strings or null

Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.

permission
integer
Default: 0
Enum: 1 2 3

1 - public, 2 - public (read-only), 3 - private

sticky
integer
category_id
integer or null
alert
integer
alert_grid
integer
alert_to
string or null <date>
alert_type
any
external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "note": null,
  • "files": [
    ],
  • "permission": 1,
  • "sticky": 0,
  • "category_id": 0,
  • "alert": 0,
  • "alert_grid": 0,
  • "alert_to": "2019-08-24",
  • "alert_type": null,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of notes

Authorizations:
BearerAuth
path Parameters
company
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
page
integer
Default: 1
limit
integer
Default: 20

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get note

Authorizations:
BearerAuth
path Parameters
company
required
integer
note
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update note

Authorizations:
BearerAuth
path Parameters
company
required
integer
note
required
integer
Request Body schema: application/json
title
string
note
any
files
Array of strings or null

Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.

permission
integer
Default: 0
Enum: 1 2 3

1 - public, 2 - public (read-only), 3 - private

sticky
integer
category_id
integer or null
alert
integer
alert_grid
integer
alert_to
string or null <date>
alert_type
any
external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "note": null,
  • "files": [
    ],
  • "permission": 1,
  • "sticky": 0,
  • "category_id": 0,
  • "alert": 0,
  • "alert_grid": 0,
  • "alert_to": "2019-08-24",
  • "alert_type": null,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete note

Authorizations:
BearerAuth
path Parameters
company
required
integer
note
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore note

Authorizations:
BearerAuth
path Parameters
company
required
integer
note
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of notes

Authorizations:
BearerAuth
path Parameters
company
required
integer
Request Body schema: application/json
Array of objects (Note)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of notes

Authorizations:
BearerAuth
path Parameters
company
required
integer
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of notes

Authorizations:
BearerAuth
path Parameters
company
required
integer
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of notes

Authorizations:
BearerAuth
path Parameters
company
required
integer
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Associate note with company

Authorizations:
BearerAuth
path Parameters
company
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Dissociate note from company

Authorizations:
BearerAuth
path Parameters
company
required
integer
note
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Company Group Api

API documentation for Company Group Api

Create company group

Authorizations:
BearerAuth
Request Body schema: application/json
slug
string or null
name
string

Responses

Request samples

Content type
application/json
{
  • "slug": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of company groups

Authorizations:
BearerAuth
query Parameters
with_trashed
boolean
only_trashed
boolean
page
integer
Default: 1
limit
integer
Default: 20

Responses

Response samples

Content type
application/json
{}

Get company group

Authorizations:
BearerAuth
path Parameters
company_group
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update company group

Authorizations:
BearerAuth
path Parameters
company_group
required
integer
Request Body schema: application/json
slug
string or null
name
string

Responses

Request samples

Content type
application/json
{
  • "slug": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete company group

Authorizations:
BearerAuth
path Parameters
company_group
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore company group

Authorizations:
BearerAuth
path Parameters
company_group
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of company groups

Authorizations:
BearerAuth
Request Body schema: application/json
Array of objects (CompanyGroup)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of company groups

Authorizations:
BearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of company groups

Authorizations:
BearerAuth
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of company groups

Authorizations:
BearerAuth
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Company Group Relation Api

API documentation for Company Group Relation Api

Create company group

Authorizations:
BearerAuth
path Parameters
company
required
integer
Request Body schema: application/json
slug
string or null
name
string

Responses

Request samples

Content type
application/json
{
  • "slug": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of company groups

Authorizations:
BearerAuth
path Parameters
company
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
page
integer
Default: 1
limit
integer
Default: 20

Responses

Response samples

Content type
application/json
{}

Get company group

Authorizations:
BearerAuth
path Parameters
company
required
integer
group
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update company group

Authorizations:
BearerAuth
path Parameters
company
required
integer
group
required
integer
Request Body schema: application/json
slug
string or null
name
string

Responses

Request samples

Content type
application/json
{
  • "slug": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete company group

Authorizations:
BearerAuth
path Parameters
company
required
integer
group
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of company groups

Authorizations:
BearerAuth
path Parameters
company
required
integer
Request Body schema: application/json
Array of objects (CompanyGroup)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of company groups

Authorizations:
BearerAuth
path Parameters
company
required
integer
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of company groups

Authorizations:
BearerAuth
path Parameters
company
required
integer
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Attach company groups

Authorizations:
BearerAuth
path Parameters
company
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ]
}

Detach company groups

Authorizations:
BearerAuth
path Parameters
company
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "detached": [
    ]
}

Sync company groups

Authorizations:
BearerAuth
path Parameters
company
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ],
  • "updated": [
    ]
}

Toggle company groups

Authorizations:
BearerAuth
path Parameters
company
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ]
}

Update pivot

Authorizations:
BearerAuth
path Parameters
company
required
integer
group
required
integer
Request Body schema: application/json
pivot
object

Pivot fields

Responses

Request samples

Content type
application/json
{
  • "pivot": { }
}

Response samples

Content type
application/json
{
  • "updated": [
    ]
}

Company Sales Representative Relation Api

API documentation for Company Sales Representative Relation Api

Get a list of contacts

Authorizations:
BearerAuth
path Parameters
company
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
page
integer
Default: 1
limit
integer
Default: 20

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contact

Authorizations:
BearerAuth
path Parameters
company
required
integer
salesRepresentative
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Attach contacts

Authorizations:
BearerAuth
path Parameters
company
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ]
}

Detach contacts

Authorizations:
BearerAuth
path Parameters
company
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "detached": [
    ]
}

Sync contacts

Authorizations:
BearerAuth
path Parameters
company
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ],
  • "updated": [
    ]
}

Toggle contacts

Authorizations:
BearerAuth
path Parameters
company
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ]
}

Contact Webhook Api

API documentation for Contact Webhook Api

Create webhook

Authorizations:
BearerAuth
Request Body schema: application/json
url
string
event
any
Enum: "created" "updated" "deleted" "restored" "saved" "all"
Array of Array of arrays or strings or null
Default: null
columns_changed
Array of strings or null
Default: null
description
string or null
active
integer

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "event": "created",
  • "payload": null,
  • "columns_changed": null,
  • "description": "string",
  • "active": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of webhooks

Authorizations:
BearerAuth
query Parameters
page
integer
Default: 1
limit
integer
Default: 20

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get webhook

Authorizations:
BearerAuth
path Parameters
webhook
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update webhook

Authorizations:
BearerAuth
path Parameters
webhook
required
integer
Request Body schema: application/json
url
string
event
any
Enum: "created" "updated" "deleted" "restored" "saved" "all"
Array of Array of arrays or strings or null
Default: null
columns_changed
Array of strings or null
Default: null
description
string or null
active
integer

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "event": "created",
  • "payload": null,
  • "columns_changed": null,
  • "description": "string",
  • "active": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete webhook

Authorizations:
BearerAuth
path Parameters
webhook
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Contact Api

API documentation for Contact Api

Create contact

Authorizations:
BearerAuth
Request Body schema: application/json
last_name
string
first_name
string
company_id
integer or null
title
string or null
work_phone
string or null
mobile_phone
string or null
email
string or null
send_docs_from_email
string or null
web_address
string or null
address_1
string or null
address_2
string or null
city
string or null
country_id
integer
state_id
integer or null
postcode
string or null
division_id
integer or null
subdivision_id
integer or null
memo
string or null
home_address_1
string or null
home_address_2
string or null
home_city
string or null
home_country_id
integer or null
home_state_id
integer or null
home_postcode
string or null
home_phone
string or null
home_longitude
any
home_latitude
any
ssn
string or null
birth_date
string or null <date>
employment_date
string or null <date>
dismissal_date
string or null <date>
marital_status
integer or null
eligible_for_benefits
string or null
withholdings
string or null
default_hour_rate
any
default_hour_rate_currency
string or null
has_custom_employer_cost_markup
integer
employer_cost_markup_percentage
any
salary_custom_percentages
integer
salary_secondary_percentage
any
overtime_primary_percentage
any
overtime_secondary_percentage
any
permission
integer
Default: 0
Enum: 1 2 3

1 - public, 2 - public (read-only), 3 - private

external_id
string or null
payable_public_holidays
integer or null
payable_vacation_days_per_year
integer or null
payable_vacation_days
any
payable_sick_days_per_year
integer or null
payable_sick_days
any
payable_personal_days_per_year
integer or null
payable_personal_days
any
payable_days_last_update
string or null <date>

Responses

Request samples

Content type
application/json
{
  • "last_name": "string",
  • "first_name": "string",
  • "company_id": 0,
  • "title": "string",
  • "work_phone": "string",
  • "mobile_phone": "string",
  • "email": "string",
  • "send_docs_from_email": "string",
  • "web_address": "string",
  • "address_1": "string",
  • "address_2": "string",
  • "city": "string",
  • "country_id": 0,
  • "state_id": 0,
  • "postcode": "string",
  • "division_id": 0,
  • "subdivision_id": 0,
  • "memo": "string",
  • "home_address_1": "string",
  • "home_address_2": "string",
  • "home_city": "string",
  • "home_country_id": 0,
  • "home_state_id": 0,
  • "home_postcode": "string",
  • "home_phone": "string",
  • "home_longitude": null,
  • "home_latitude": null,
  • "ssn": "string",
  • "birth_date": "2019-08-24",
  • "employment_date": "2019-08-24",
  • "dismissal_date": "2019-08-24",
  • "marital_status": 0,
  • "eligible_for_benefits": "string",
  • "withholdings": "string",
  • "default_hour_rate": null,
  • "default_hour_rate_currency": "string",
  • "has_custom_employer_cost_markup": 0,
  • "employer_cost_markup_percentage": null,
  • "salary_custom_percentages": 0,
  • "salary_secondary_percentage": null,
  • "overtime_primary_percentage": null,
  • "overtime_secondary_percentage": null,
  • "permission": 1,
  • "external_id": "string",
  • "payable_public_holidays": 0,
  • "payable_vacation_days_per_year": 0,
  • "payable_vacation_days": null,
  • "payable_sick_days_per_year": 0,
  • "payable_sick_days": null,
  • "payable_personal_days_per_year": 0,
  • "payable_personal_days": null,
  • "payable_days_last_update": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of contacts

Authorizations:
BearerAuth
query Parameters
with_trashed
boolean
only_trashed
boolean
page
integer
Default: 1
limit
integer
Default: 20

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contact

Authorizations:
BearerAuth
path Parameters
contact
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update contact

Authorizations:
BearerAuth
path Parameters
contact
required
integer
Request Body schema: application/json
last_name
string
first_name
string
company_id
integer or null
title
string or null
work_phone
string or null
mobile_phone
string or null
email
string or null
send_docs_from_email
string or null
web_address
string or null
address_1
string or null
address_2
string or null
city
string or null
country_id
integer
state_id
integer or null
postcode
string or null
division_id
integer or null
subdivision_id
integer or null
memo
string or null
home_address_1
string or null
home_address_2
string or null
home_city
string or null
home_country_id
integer or null
home_state_id
integer or null
home_postcode
string or null
home_phone
string or null
home_longitude
any
home_latitude
any
ssn
string or null
birth_date
string or null <date>
employment_date
string or null <date>
dismissal_date
string or null <date>
marital_status
integer or null
eligible_for_benefits
string or null
withholdings
string or null
default_hour_rate
any
default_hour_rate_currency
string or null
has_custom_employer_cost_markup
integer
employer_cost_markup_percentage
any
salary_custom_percentages
integer
salary_secondary_percentage
any
overtime_primary_percentage
any
overtime_secondary_percentage
any
permission
integer
Default: 0
Enum: 1 2 3

1 - public, 2 - public (read-only), 3 - private

external_id
string or null
payable_public_holidays
integer or null
payable_vacation_days_per_year
integer or null
payable_vacation_days
any
payable_sick_days_per_year
integer or null
payable_sick_days
any
payable_personal_days_per_year
integer or null
payable_personal_days
any
payable_days_last_update
string or null <date>

Responses

Request samples

Content type
application/json
{
  • "last_name": "string",
  • "first_name": "string",
  • "company_id": 0,
  • "title": "string",
  • "work_phone": "string",
  • "mobile_phone": "string",
  • "email": "string",
  • "send_docs_from_email": "string",
  • "web_address": "string",
  • "address_1": "string",
  • "address_2": "string",
  • "city": "string",
  • "country_id": 0,
  • "state_id": 0,
  • "postcode": "string",
  • "division_id": 0,
  • "subdivision_id": 0,
  • "memo": "string",
  • "home_address_1": "string",
  • "home_address_2": "string",
  • "home_city": "string",
  • "home_country_id": 0,
  • "home_state_id": 0,
  • "home_postcode": "string",
  • "home_phone": "string",
  • "home_longitude": null,
  • "home_latitude": null,
  • "ssn": "string",
  • "birth_date": "2019-08-24",
  • "employment_date": "2019-08-24",
  • "dismissal_date": "2019-08-24",
  • "marital_status": 0,
  • "eligible_for_benefits": "string",
  • "withholdings": "string",
  • "default_hour_rate": null,
  • "default_hour_rate_currency": "string",
  • "has_custom_employer_cost_markup": 0,
  • "employer_cost_markup_percentage": null,
  • "salary_custom_percentages": 0,
  • "salary_secondary_percentage": null,
  • "overtime_primary_percentage": null,
  • "overtime_secondary_percentage": null,
  • "permission": 1,
  • "external_id": "string",
  • "payable_public_holidays": 0,
  • "payable_vacation_days_per_year": 0,
  • "payable_vacation_days": null,
  • "payable_sick_days_per_year": 0,
  • "payable_sick_days": null,
  • "payable_personal_days_per_year": 0,
  • "payable_personal_days": null,
  • "payable_days_last_update": "2019-08-24"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete contact

Authorizations:
BearerAuth
path Parameters
contact
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore contact

Authorizations:
BearerAuth
path Parameters
contact
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of contacts

Authorizations:
BearerAuth
Request Body schema: application/json
Array of objects (Contact)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of contacts

Authorizations:
BearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of contacts

Authorizations:
BearerAuth
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of contacts

Authorizations:
BearerAuth
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Contact Notes Relation Api

API documentation for Contact Notes Relation Api

Create note

Authorizations:
BearerAuth
path Parameters
contact
required
integer
Request Body schema: application/json
title
string
note
any
files
Array of strings or null

Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.

permission
integer
Default: 0
Enum: 1 2 3

1 - public, 2 - public (read-only), 3 - private

sticky
integer
category_id
integer or null
alert
integer
alert_grid
integer
alert_to
string or null <date>
alert_type
any
external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "note": null,
  • "files": [
    ],
  • "permission": 1,
  • "sticky": 0,
  • "category_id": 0,
  • "alert": 0,
  • "alert_grid": 0,
  • "alert_to": "2019-08-24",
  • "alert_type": null,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of notes

Authorizations:
BearerAuth
path Parameters
contact
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
page
integer
Default: 1
limit
integer
Default: 20

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get note

Authorizations:
BearerAuth
path Parameters
contact
required
integer
note
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update note

Authorizations:
BearerAuth
path Parameters
contact
required
integer
note
required
integer
Request Body schema: application/json
title
string
note
any
files
Array of strings or null

Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.

permission
integer
Default: 0
Enum: 1 2 3

1 - public, 2 - public (read-only), 3 - private

sticky
integer
category_id
integer or null
alert
integer
alert_grid
integer
alert_to
string or null <date>
alert_type
any
external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "note": null,
  • "files": [
    ],
  • "permission": 1,
  • "sticky": 0,
  • "category_id": 0,
  • "alert": 0,
  • "alert_grid": 0,
  • "alert_to": "2019-08-24",
  • "alert_type": null,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete note

Authorizations:
BearerAuth
path Parameters
contact
required
integer
note
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore note

Authorizations:
BearerAuth
path Parameters
contact
required
integer
note
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of notes

Authorizations:
BearerAuth
path Parameters
contact
required
integer
Request Body schema: application/json
Array of objects (Note)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of notes

Authorizations:
BearerAuth
path Parameters
contact
required
integer
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of notes

Authorizations:
BearerAuth
path Parameters
contact
required
integer
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of notes

Authorizations:
BearerAuth
path Parameters
contact
required
integer
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Associate note with contact

Authorizations:
BearerAuth
path Parameters
contact
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Dissociate note from contact

Authorizations:
BearerAuth
path Parameters
contact
required
integer
note
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Contact Group Api

API documentation for Contact Group Api

Create contact group

Authorizations:
BearerAuth
Request Body schema: application/json
slug
string or null
name
string
filter
integer

Responses

Request samples

Content type
application/json
{
  • "slug": "string",
  • "name": "string",
  • "filter": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of contact groups

Authorizations:
BearerAuth
query Parameters
with_trashed
boolean
only_trashed
boolean
page
integer
Default: 1
limit
integer
Default: 20

Responses

Response samples

Content type
application/json
{}

Get contact group

Authorizations:
BearerAuth
path Parameters
contact_group
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update contact group

Authorizations:
BearerAuth
path Parameters
contact_group
required
integer
Request Body schema: application/json
slug
string or null
name
string
filter
integer

Responses

Request samples

Content type
application/json
{
  • "slug": "string",
  • "name": "string",
  • "filter": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete contact group

Authorizations:
BearerAuth
path Parameters
contact_group
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore contact group

Authorizations:
BearerAuth
path Parameters
contact_group
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of contact groups

Authorizations:
BearerAuth
Request Body schema: application/json
Array of objects (ContactGroup)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of contact groups

Authorizations:
BearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of contact groups

Authorizations:
BearerAuth
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of contact groups

Authorizations:
BearerAuth
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Contact Group Relation Api

API documentation for Contact Group Relation Api

Create contact group

Authorizations:
BearerAuth
path Parameters
contact
required
integer
Request Body schema: application/json
slug
string or null
name
string
filter
integer

Responses

Request samples

Content type
application/json
{
  • "slug": "string",
  • "name": "string",
  • "filter": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of contact groups

Authorizations:
BearerAuth
path Parameters
contact
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
page
integer
Default: 1
limit
integer
Default: 20

Responses

Response samples

Content type
application/json
{}

Get contact group

Authorizations:
BearerAuth
path Parameters
contact
required
integer
group
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update contact group

Authorizations:
BearerAuth
path Parameters
contact
required
integer
group
required
integer
Request Body schema: application/json
slug
string or null
name
string
filter
integer

Responses

Request samples

Content type
application/json
{
  • "slug": "string",
  • "name": "string",
  • "filter": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete contact group

Authorizations:
BearerAuth
path Parameters
contact
required
integer
group
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of contact groups

Authorizations:
BearerAuth
path Parameters
contact
required
integer
Request Body schema: application/json
Array of objects (ContactGroup)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of contact groups

Authorizations:
BearerAuth
path Parameters
contact
required
integer
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of contact groups

Authorizations:
BearerAuth
path Parameters
contact
required
integer
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Attach contact groups

Authorizations:
BearerAuth
path Parameters
contact
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ]
}

Detach contact groups

Authorizations:
BearerAuth
path Parameters
contact
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "detached": [
    ]
}

Sync contact groups

Authorizations:
BearerAuth
path Parameters
contact
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ],
  • "updated": [
    ]
}

Toggle contact groups

Authorizations:
BearerAuth
path Parameters
contact
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ]
}

Update pivot

Authorizations:
BearerAuth
path Parameters
contact
required
integer
group
required
integer
Request Body schema: application/json
pivot
object

Pivot fields

Responses

Request samples

Content type
application/json
{
  • "pivot": { }
}

Response samples

Content type
application/json
{
  • "updated": [
    ]
}

Contact Sales Representative Relation Api

API documentation for Contact Sales Representative Relation Api

Get a list of contacts

Authorizations:
BearerAuth
path Parameters
contact
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
page
integer
Default: 1
limit
integer
Default: 20

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contact

Authorizations:
BearerAuth
path Parameters
contact
required
integer
salesRepresentative
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Attach contacts

Authorizations:
BearerAuth
path Parameters
contact
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ]
}

Detach contacts

Authorizations:
BearerAuth
path Parameters
contact
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "detached": [
    ]
}

Sync contacts

Authorizations:
BearerAuth
path Parameters
contact
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ],
  • "updated": [
    ]
}

Toggle contacts

Authorizations:
BearerAuth
path Parameters
contact
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ]
}

Meeting Webhook Api

API documentation for Meeting Webhook Api

Create webhook

Authorizations:
BearerAuth
Request Body schema: application/json
url
string
event
any
Enum: "created" "updated" "deleted" "restored" "saved" "all"
Array of Array of arrays or strings or null
Default: null
columns_changed
Array of strings or null
Default: null
description
string or null
active
integer

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "event": "created",
  • "payload": null,
  • "columns_changed": null,
  • "description": "string",
  • "active": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of webhooks

Authorizations:
BearerAuth
query Parameters
page
integer
Default: 1
limit
integer
Default: 20

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get webhook

Authorizations:
BearerAuth
path Parameters
webhook
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update webhook

Authorizations:
BearerAuth
path Parameters
webhook
required
integer
Request Body schema: application/json
url
string
event
any
Enum: "created" "updated" "deleted" "restored" "saved" "all"
Array of Array of arrays or strings or null
Default: null
columns_changed
Array of strings or null
Default: null
description
string or null
active
integer

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "event": "created",
  • "payload": null,
  • "columns_changed": null,
  • "description": "string",
  • "active": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete webhook

Authorizations:
BearerAuth
path Parameters
webhook
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Meeting Api

API documentation for Meeting Api

Create meeting

Authorizations:
BearerAuth
Request Body schema: application/json
title
string
schedule_type
string
Enum: "date" "datetime"
scheduled_date
string or null <date>
start
string or null
end
string or null
priority
integer
description
string or null
permission
integer
Default: 0
Enum: 1 2 3

1 - public, 2 - public (read-only), 3 - private

project_status
any
project_bidding_id
integer or null
project_id
integer or null
recurring
integer
recurring_type
string or null
recurring_interval
integer or null
recurring_month
string or null
recurring_weekday
any
recurring_end
string or null <date>
location_id
integer or null
external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "schedule_type": "date",
  • "scheduled_date": "2019-08-24",
  • "start": "string",
  • "end": "string",
  • "priority": 0,
  • "description": "string",
  • "permission": 1,
  • "project_status": null,
  • "project_bidding_id": 0,
  • "project_id": 0,
  • "recurring": 0,
  • "recurring_type": "string",
  • "recurring_interval": 0,
  • "recurring_month": "string",
  • "recurring_weekday": null,
  • "recurring_end": "2019-08-24",
  • "location_id": 0,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of meetings

Authorizations:
BearerAuth
query Parameters
with_trashed
boolean
only_trashed
boolean
page
integer
Default: 1
limit
integer
Default: 20

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get meeting

Authorizations:
BearerAuth
path Parameters
meeting
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update meeting

Authorizations:
BearerAuth
path Parameters
meeting
required
integer
Request Body schema: application/json
title
string
schedule_type
string
Enum: "date" "datetime"
scheduled_date
string or null <date>
start
string or null
end
string or null
priority
integer
description
string or null
permission
integer
Default: 0
Enum: 1 2 3

1 - public, 2 - public (read-only), 3 - private

project_status
any
project_bidding_id
integer or null
project_id
integer or null
recurring
integer
recurring_type
string or null
recurring_interval
integer or null
recurring_month
string or null
recurring_weekday
any
recurring_end
string or null <date>
location_id
integer or null
external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "schedule_type": "date",
  • "scheduled_date": "2019-08-24",
  • "start": "string",
  • "end": "string",
  • "priority": 0,
  • "description": "string",
  • "permission": 1,
  • "project_status": null,
  • "project_bidding_id": 0,
  • "project_id": 0,
  • "recurring": 0,
  • "recurring_type": "string",
  • "recurring_interval": 0,
  • "recurring_month": "string",
  • "recurring_weekday": null,
  • "recurring_end": "2019-08-24",
  • "location_id": 0,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete meeting

Authorizations:
BearerAuth
path Parameters
meeting
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore meeting

Authorizations:
BearerAuth
path Parameters
meeting
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of meetings

Authorizations:
BearerAuth
Request Body schema: application/json
Array of objects (Meeting)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of meetings

Authorizations:
BearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of meetings

Authorizations:
BearerAuth
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of meetings

Authorizations:
BearerAuth
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Meeting Notes Relation Api

API documentation for Meeting Notes Relation Api

Create note

Authorizations:
BearerAuth
path Parameters
meeting
required
integer
Request Body schema: application/json
title
string
note
any
files
Array of strings or null

Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.

permission
integer
Default: 0
Enum: 1 2 3

1 - public, 2 - public (read-only), 3 - private

sticky
integer
category_id
integer or null
alert
integer
alert_grid
integer
alert_to
string or null <date>
alert_type
any
external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "note": null,
  • "files": [
    ],
  • "permission": 1,
  • "sticky": 0,
  • "category_id": 0,
  • "alert": 0,
  • "alert_grid": 0,
  • "alert_to": "2019-08-24",
  • "alert_type": null,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of notes

Authorizations:
BearerAuth
path Parameters
meeting
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
page
integer
Default: 1
limit
integer
Default: 20

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get note

Authorizations:
BearerAuth
path Parameters
meeting
required
integer
note
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update note

Authorizations:
BearerAuth
path Parameters
meeting
required
integer
note
required
integer
Request Body schema: application/json
title
string
note
any
files
Array of strings or null

Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.

permission
integer
Default: 0
Enum: 1 2 3

1 - public, 2 - public (read-only), 3 - private

sticky
integer
category_id
integer or null
alert
integer
alert_grid
integer
alert_to
string or null <date>
alert_type
any
external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "note": null,
  • "files": [
    ],
  • "permission": 1,
  • "sticky": 0,
  • "category_id": 0,
  • "alert": 0,
  • "alert_grid": 0,
  • "alert_to": "2019-08-24",
  • "alert_type": null,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete note

Authorizations:
BearerAuth
path Parameters
meeting
required
integer
note
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore note

Authorizations:
BearerAuth
path Parameters
meeting
required
integer
note
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of notes

Authorizations:
BearerAuth
path Parameters
meeting
required
integer
Request Body schema: application/json
Array of objects (Note)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of notes

Authorizations:
BearerAuth
path Parameters
meeting
required
integer
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of notes

Authorizations:
BearerAuth
path Parameters
meeting
required
integer
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of notes

Authorizations:
BearerAuth
path Parameters
meeting
required
integer
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Associate note with meeting

Authorizations:
BearerAuth
path Parameters
meeting
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Dissociate note from meeting

Authorizations:
BearerAuth
path Parameters
meeting
required
integer
note
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Meeting Customer Relation Api

API documentation for Meeting Customer Relation Api

Get a list of contacts

Authorizations:
BearerAuth
path Parameters
meeting
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
page
integer
Default: 1
limit
integer
Default: 20

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contact

Authorizations:
BearerAuth
path Parameters
meeting
required
integer
customer
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Attach contacts

Authorizations:
BearerAuth
path Parameters
meeting
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ]
}

Detach contacts

Authorizations:
BearerAuth
path Parameters
meeting
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "detached": [
    ]
}

Sync contacts

Authorizations:
BearerAuth
path Parameters
meeting
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ],
  • "updated": [
    ]
}

Toggle contacts

Authorizations:
BearerAuth
path Parameters
meeting
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ]
}

Meeting Employee Relation Api

API documentation for Meeting Employee Relation Api

Get a list of contacts

Authorizations:
BearerAuth
path Parameters
meeting
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
page
integer
Default: 1
limit
integer
Default: 20

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contact

Authorizations:
BearerAuth
path Parameters
meeting
required
integer
employee
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Attach contacts

Authorizations:
BearerAuth
path Parameters
meeting
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ]
}

Detach contacts

Authorizations:
BearerAuth
path Parameters
meeting
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "detached": [
    ]
}

Sync contacts

Authorizations:
BearerAuth
path Parameters
meeting
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ],
  • "updated": [
    ]
}

Toggle contacts

Authorizations:
BearerAuth
path Parameters
meeting
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ]
}

Meeting Location Api

API documentation for Meeting Location Api

Create meeting location

Authorizations:
BearerAuth
Request Body schema: application/json
name
string
active
integer

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "active": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of meeting locations

Authorizations:
BearerAuth
query Parameters
with_trashed
boolean
only_trashed
boolean
page
integer
Default: 1
limit
integer
Default: 20

Responses

Response samples

Content type
application/json
{}

Get meeting location

Authorizations:
BearerAuth
path Parameters
meeting_location
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update meeting location

Authorizations:
BearerAuth
path Parameters
meeting_location
required
integer
Request Body schema: application/json
name
string
active
integer

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "active": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete meeting location

Authorizations:
BearerAuth
path Parameters
meeting_location
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore meeting location

Authorizations:
BearerAuth
path Parameters
meeting_location
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of meeting locations

Authorizations:
BearerAuth
Request Body schema: application/json
Array of objects (MeetingLocation)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of meeting locations

Authorizations:
BearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of meeting locations

Authorizations:
BearerAuth
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of meeting locations

Authorizations:
BearerAuth
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Task Webhook Api

API documentation for Task Webhook Api

Create webhook

Authorizations:
BearerAuth
Request Body schema: application/json
url
string
event
any
Enum: "created" "updated" "deleted" "restored" "saved" "all"
Array of Array of arrays or strings or null
Default: null
columns_changed
Array of strings or null
Default: null
description
string or null
active
integer

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "event": "created",
  • "payload": null,
  • "columns_changed": null,
  • "description": "string",
  • "active": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of webhooks

Authorizations:
BearerAuth
query Parameters
page
integer
Default: 1
limit
integer
Default: 20

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get webhook

Authorizations:
BearerAuth
path Parameters
webhook
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update webhook

Authorizations:
BearerAuth
path Parameters
webhook
required
integer
Request Body schema: application/json
url
string
event
any
Enum: "created" "updated" "deleted" "restored" "saved" "all"
Array of Array of arrays or strings or null
Default: null
columns_changed
Array of strings or null
Default: null
description
string or null
active
integer

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "event": "created",
  • "payload": null,
  • "columns_changed": null,
  • "description": "string",
  • "active": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete webhook

Authorizations:
BearerAuth
path Parameters
webhook
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Task Api

API documentation for Task Api

Create task

Authorizations:
BearerAuth
Request Body schema: application/json
title
string
status
integer
priority
integer
due_type
string
Enum: "date" "datetime"
due_date
string or null <date>
due_at
string or null
description
string or null
permission
integer
Default: 0
Enum: 1 2 3

1 - public, 2 - public (read-only), 3 - private

project_status
any
project_bidding_id
integer or null
project_id
integer or null
external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "status": 0,
  • "priority": 0,
  • "due_type": "date",
  • "due_date": "2019-08-24",
  • "due_at": "string",
  • "description": "string",
  • "permission": 1,
  • "project_status": null,
  • "project_bidding_id": 0,
  • "project_id": 0,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of tasks

Authorizations:
BearerAuth
query Parameters
with_trashed
boolean
only_trashed
boolean
page
integer
Default: 1
limit
integer
Default: 20

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get task

Authorizations:
BearerAuth
path Parameters
task
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update task

Authorizations:
BearerAuth
path Parameters
task
required
integer
Request Body schema: application/json
title
string
status
integer
priority
integer
due_type
string
Enum: "date" "datetime"
due_date
string or null <date>
due_at
string or null
description
string or null
permission
integer
Default: 0
Enum: 1 2 3

1 - public, 2 - public (read-only), 3 - private

project_status
any
project_bidding_id
integer or null
project_id
integer or null
external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "status": 0,
  • "priority": 0,
  • "due_type": "date",
  • "due_date": "2019-08-24",
  • "due_at": "string",
  • "description": "string",
  • "permission": 1,
  • "project_status": null,
  • "project_bidding_id": 0,
  • "project_id": 0,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete task

Authorizations:
BearerAuth
path Parameters
task
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore task

Authorizations:
BearerAuth
path Parameters
task
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of tasks

Authorizations:
BearerAuth
Request Body schema: application/json
Array of objects (Task)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of tasks

Authorizations:
BearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of tasks

Authorizations:
BearerAuth
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of tasks

Authorizations:
BearerAuth
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Task Notes Relation Api

API documentation for Task Notes Relation Api

Create note

Authorizations:
BearerAuth
path Parameters
task
required
integer
Request Body schema: application/json
title
string
note
any
files
Array of strings or null

Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.

permission
integer
Default: 0
Enum: 1 2 3

1 - public, 2 - public (read-only), 3 - private

sticky
integer
category_id
integer or null
alert
integer
alert_grid
integer
alert_to
string or null <date>
alert_type
any
external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "note": null,
  • "files": [
    ],
  • "permission": 1,
  • "sticky": 0,
  • "category_id": 0,
  • "alert": 0,
  • "alert_grid": 0,
  • "alert_to": "2019-08-24",
  • "alert_type": null,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of notes

Authorizations:
BearerAuth
path Parameters
task
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
page
integer
Default: 1
limit
integer
Default: 20

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get note

Authorizations:
BearerAuth
path Parameters
task
required
integer
note
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update note

Authorizations:
BearerAuth
path Parameters
task
required
integer
note
required
integer
Request Body schema: application/json
title
string
note
any
files
Array of strings or null

Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.

permission
integer
Default: 0
Enum: 1 2 3

1 - public, 2 - public (read-only), 3 - private

sticky
integer
category_id
integer or null
alert
integer
alert_grid
integer
alert_to
string or null <date>
alert_type
any
external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "note": null,
  • "files": [
    ],
  • "permission": 1,
  • "sticky": 0,
  • "category_id": 0,
  • "alert": 0,
  • "alert_grid": 0,
  • "alert_to": "2019-08-24",
  • "alert_type": null,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete note

Authorizations:
BearerAuth
path Parameters
task
required
integer
note
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore note

Authorizations:
BearerAuth
path Parameters
task
required
integer
note
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of notes

Authorizations:
BearerAuth
path Parameters
task
required
integer
Request Body schema: application/json
Array of objects (Note)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of notes

Authorizations:
BearerAuth
path Parameters
task
required
integer
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of notes

Authorizations:
BearerAuth
path Parameters
task
required
integer
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of notes

Authorizations:
BearerAuth
path Parameters
task
required
integer
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Associate note with task

Authorizations:
BearerAuth
path Parameters
task
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Dissociate note from task

Authorizations:
BearerAuth
path Parameters
task
required
integer
note
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Task Customer Relation Api

API documentation for Task Customer Relation Api

Get a list of contacts

Authorizations:
BearerAuth
path Parameters
task
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
page
integer
Default: 1
limit
integer
Default: 20

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contact

Authorizations:
BearerAuth
path Parameters
task
required
integer
customer
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Attach contacts

Authorizations:
BearerAuth
path Parameters
task
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ]
}

Detach contacts

Authorizations:
BearerAuth
path Parameters
task
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "detached": [
    ]
}

Sync contacts

Authorizations:
BearerAuth
path Parameters
task
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ],
  • "updated": [
    ]
}

Toggle contacts

Authorizations:
BearerAuth
path Parameters
task
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ]
}

Task Employee Relation Api

API documentation for Task Employee Relation Api

Get a list of contacts

Authorizations:
BearerAuth
path Parameters
task
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
page
integer
Default: 1
limit
integer
Default: 20

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contact

Authorizations:
BearerAuth
path Parameters
task
required
integer
employee
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Attach contacts

Authorizations:
BearerAuth
path Parameters
task
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ]
}

Detach contacts

Authorizations:
BearerAuth
path Parameters
task
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "detached": [
    ]
}

Sync contacts

Authorizations:
BearerAuth
path Parameters
task
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ],
  • "updated": [
    ]
}

Toggle contacts

Authorizations:
BearerAuth
path Parameters
task
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ]
}

Phone Call Webhook Api

API documentation for Phone Call Webhook Api

Create webhook

Authorizations:
BearerAuth
Request Body schema: application/json
url
string
event
any
Enum: "created" "updated" "deleted" "restored" "saved" "all"
Array of Array of arrays or strings or null
Default: null
columns_changed
Array of strings or null
Default: null
description
string or null
active
integer

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "event": "created",
  • "payload": null,
  • "columns_changed": null,
  • "description": "string",
  • "active": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of webhooks

Authorizations:
BearerAuth
query Parameters
page
integer
Default: 1
limit
integer
Default: 20

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get webhook

Authorizations:
BearerAuth
path Parameters
webhook
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update webhook

Authorizations:
BearerAuth
path Parameters
webhook
required
integer
Request Body schema: application/json
url
string
event
any
Enum: "created" "updated" "deleted" "restored" "saved" "all"
Array of Array of arrays or strings or null
Default: null
columns_changed
Array of strings or null
Default: null
description
string or null
active
integer

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "event": "created",
  • "payload": null,
  • "columns_changed": null,
  • "description": "string",
  • "active": 0
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete webhook

Authorizations:
BearerAuth
path Parameters
webhook
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Phone Call Api

API documentation for Phone Call Api

Create phone call

Authorizations:
BearerAuth
Request Body schema: application/json
subject
string
schedule_type
string
Enum: "date" "datetime"
scheduled_date
string or null <date>
scheduled_at
string or null
contact_company_switch
integer
company_id
integer or null
contact_id
integer or null
mobile_phone_field
string or null
other_customer_name
string or null
other_phone_number
string or null
status
integer
priority
integer
description
string or null
permission
integer
Default: 0
Enum: 1 2 3

1 - public, 2 - public (read-only), 3 - private

project_status
any
project_bidding_id
integer or null
project_id
integer or null
is_followup
integer
external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "subject": "string",
  • "schedule_type": "date",
  • "scheduled_date": "2019-08-24",
  • "scheduled_at": "string",
  • "contact_company_switch": 0,
  • "company_id": 0,
  • "contact_id": 0,
  • "mobile_phone_field": "string",
  • "other_customer_name": "string",
  • "other_phone_number": "string",
  • "status": 0,
  • "priority": 0,
  • "description": "string",
  • "permission": 1,
  • "project_status": null,
  • "project_bidding_id": 0,
  • "project_id": 0,
  • "is_followup": 0,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of phone calls

Authorizations:
BearerAuth
query Parameters
with_trashed
boolean
only_trashed
boolean
page
integer
Default: 1
limit
integer
Default: 20

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get phone call

Authorizations:
BearerAuth
path Parameters
phonecall
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update phone call

Authorizations:
BearerAuth
path Parameters
phonecall
required
integer
Request Body schema: application/json
subject
string
schedule_type
string
Enum: "date" "datetime"
scheduled_date
string or null <date>
scheduled_at
string or null
contact_company_switch
integer
company_id
integer or null
contact_id
integer or null
mobile_phone_field
string or null
other_customer_name
string or null
other_phone_number
string or null
status
integer
priority
integer
description
string or null
permission
integer
Default: 0
Enum: 1 2 3

1 - public, 2 - public (read-only), 3 - private

project_status
any
project_bidding_id
integer or null
project_id
integer or null
is_followup
integer
external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "subject": "string",
  • "schedule_type": "date",
  • "scheduled_date": "2019-08-24",
  • "scheduled_at": "string",
  • "contact_company_switch": 0,
  • "company_id": 0,
  • "contact_id": 0,
  • "mobile_phone_field": "string",
  • "other_customer_name": "string",
  • "other_phone_number": "string",
  • "status": 0,
  • "priority": 0,
  • "description": "string",
  • "permission": 1,
  • "project_status": null,
  • "project_bidding_id": 0,
  • "project_id": 0,
  • "is_followup": 0,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete phone call

Authorizations:
BearerAuth
path Parameters
phonecall
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore phone call

Authorizations:
BearerAuth
path Parameters
phonecall
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of phone calls

Authorizations:
BearerAuth
Request Body schema: application/json
Array of objects (PhoneCall)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of phone calls

Authorizations:
BearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of phone calls

Authorizations:
BearerAuth
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of phone calls

Authorizations:
BearerAuth
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Phone Call Notes Relation Api

API documentation for Phone Call Notes Relation Api

Create note

Authorizations:
BearerAuth
path Parameters
phonecall
required
integer
Request Body schema: application/json
title
string
note
any
files
Array of strings or null

Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.

permission
integer
Default: 0
Enum: 1 2 3

1 - public, 2 - public (read-only), 3 - private

sticky
integer
category_id
integer or null
alert
integer
alert_grid
integer
alert_to
string or null <date>
alert_type
any
external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "note": null,
  • "files": [
    ],
  • "permission": 1,
  • "sticky": 0,
  • "category_id": 0,
  • "alert": 0,
  • "alert_grid": 0,
  • "alert_to": "2019-08-24",
  • "alert_type": null,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of notes

Authorizations:
BearerAuth
path Parameters
phonecall
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
page
integer
Default: 1
limit
integer
Default: 20

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get note

Authorizations:
BearerAuth
path Parameters
phonecall
required
integer
note
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update note

Authorizations:
BearerAuth
path Parameters
phonecall
required
integer
note
required
integer
Request Body schema: application/json
title
string
note
any
files
Array of strings or null

Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.

permission
integer
Default: 0
Enum: 1 2 3

1 - public, 2 - public (read-only), 3 - private

sticky
integer
category_id
integer or null
alert
integer
alert_grid
integer
alert_to
string or null <date>
alert_type
any
external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "note": null,
  • "files": [
    ],
  • "permission": 1,
  • "sticky": 0,
  • "category_id": 0,
  • "alert": 0,
  • "alert_grid": 0,
  • "alert_to": "2019-08-24",
  • "alert_type": null,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete note

Authorizations:
BearerAuth
path Parameters
phonecall
required
integer
note
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore note

Authorizations:
BearerAuth
path Parameters
phonecall
required
integer
note
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of notes

Authorizations:
BearerAuth
path Parameters
phonecall
required
integer
Request Body schema: application/json
Array of objects (Note)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of notes

Authorizations:
BearerAuth
path Parameters
phonecall
required
integer
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of notes

Authorizations:
BearerAuth
path Parameters
phonecall
required
integer
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of notes

Authorizations:
BearerAuth
path Parameters
phonecall
required
integer
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Associate note with phone call

Authorizations:
BearerAuth
path Parameters
phonecall
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Dissociate note from phone call

Authorizations:
BearerAuth
path Parameters
phonecall
required
integer
note
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Phone Call Employee Relation Api

API documentation for Phone Call Employee Relation Api

Get a list of contacts

Authorizations:
BearerAuth
path Parameters
phonecall
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
page
integer
Default: 1
limit
integer
Default: 20

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get contact

Authorizations:
BearerAuth
path Parameters
phonecall
required
integer
employee
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Attach contacts

Authorizations:
BearerAuth
path Parameters
phonecall
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ]
}

Detach contacts

Authorizations:
BearerAuth
path Parameters
phonecall
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "detached": [
    ]
}

Sync contacts

Authorizations:
BearerAuth
path Parameters
phonecall
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ],
  • "updated": [
    ]
}

Toggle contacts

Authorizations:
BearerAuth
path Parameters
phonecall
required
integer
Request Body schema: application/json
resources
Array of objects

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "attached": [
    ],
  • "detached": [
    ]
}

Warehouse Api

API documentation for Warehouse Api

Create assets warehouse

Authorizations:
BearerAuth
Request Body schema: application/json
name
string
address_1
string or null
address_2
string or null
city
string or null
country_id
integer
state_id
integer or null
postcode
string or null
active
integer
external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "address_1": "string",
  • "address_2": "string",
  • "city": "string",
  • "country_id": 0,
  • "state_id": 0,
  • "postcode": "string",
  • "active": 0,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of assets warehouses

Authorizations:
BearerAuth
query Parameters
with_trashed
boolean
only_trashed
boolean
page
integer
Default: 1
limit
integer
Default: 20

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get assets warehouse

Authorizations:
BearerAuth
path Parameters
warehouse
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update assets warehouse

Authorizations:
BearerAuth
path Parameters
warehouse
required
integer
Request Body schema: application/json
name
string
address_1
string or null
address_2
string or null
city
string or null
country_id
integer
state_id
integer or null
postcode
string or null
active
integer
external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "address_1": "string",
  • "address_2": "string",
  • "city": "string",
  • "country_id": 0,
  • "state_id": 0,
  • "postcode": "string",
  • "active": 0,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete assets warehouse

Authorizations:
BearerAuth
path Parameters
warehouse
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore assets warehouse

Authorizations:
BearerAuth
path Parameters
warehouse
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of assets warehouses

Authorizations:
BearerAuth
Request Body schema: application/json
Array of objects (Warehouse)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of assets warehouses

Authorizations:
BearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of assets warehouses

Authorizations:
BearerAuth
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of assets warehouses

Authorizations:
BearerAuth
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Inventory Api

API documentation for Inventory Api

Create assets inventory

Authorizations:
BearerAuth
Request Body schema: application/json
name
string
barcode
string or null
minimum_threshold
any
requested_quantity
any
quantity
any
available_quantity
any
quantity_unit
string
last_purchase_id
integer or null
category_id
integer or null
suggested_sell_price
any
suggested_sell_price_currency
string or null
bom_enabled
integer
bom_labor_hours_per_unit
any
memo
string or null
external_id
string or null
warehouse_quantity
any

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "barcode": "string",
  • "minimum_threshold": null,
  • "requested_quantity": null,
  • "quantity": null,
  • "available_quantity": null,
  • "quantity_unit": "string",
  • "last_purchase_id": 0,
  • "category_id": 0,
  • "suggested_sell_price": null,
  • "suggested_sell_price_currency": "string",
  • "bom_enabled": 0,
  • "bom_labor_hours_per_unit": null,
  • "memo": "string",
  • "external_id": "string",
  • "warehouse_quantity": null
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of assets inventory

Authorizations:
BearerAuth
query Parameters
with_trashed
boolean
only_trashed
boolean
page
integer
Default: 1
limit
integer
Default: 20

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get assets inventory

Authorizations:
BearerAuth
path Parameters
inventory
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update assets inventory

Authorizations:
BearerAuth
path Parameters
inventory
required
integer
Request Body schema: application/json
name
string
barcode
string or null
minimum_threshold
any
requested_quantity
any
quantity
any
available_quantity
any
quantity_unit
string
last_purchase_id
integer or null
category_id
integer or null
suggested_sell_price
any
suggested_sell_price_currency
string or null
bom_enabled
integer
bom_labor_hours_per_unit
any
memo
string or null
external_id
string or null
warehouse_quantity
any

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "barcode": "string",
  • "minimum_threshold": null,
  • "requested_quantity": null,
  • "quantity": null,
  • "available_quantity": null,
  • "quantity_unit": "string",
  • "last_purchase_id": 0,
  • "category_id": 0,
  • "suggested_sell_price": null,
  • "suggested_sell_price_currency": "string",
  • "bom_enabled": 0,
  • "bom_labor_hours_per_unit": null,
  • "memo": "string",
  • "external_id": "string",
  • "warehouse_quantity": null
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete assets inventory

Authorizations:
BearerAuth
path Parameters
inventory
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore assets inventory

Authorizations:
BearerAuth
path Parameters
inventory
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of assets inventory

Authorizations:
BearerAuth
Request Body schema: application/json
Array of objects (Inventory)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of assets inventory

Authorizations:
BearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of assets inventory

Authorizations:
BearerAuth
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of assets inventory

Authorizations:
BearerAuth
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Inventory Notes Relation Api

API documentation for Inventory Notes Relation Api

Create note

Authorizations:
BearerAuth
path Parameters
inventory
required
integer
Request Body schema: application/json
title
string
note
any
files
Array of strings or null

Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.

permission
integer
Default: 0
Enum: 1 2 3

1 - public, 2 - public (read-only), 3 - private

sticky
integer
category_id
integer or null
alert
integer
alert_grid
integer
alert_to
string or null <date>
alert_type
any
external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "note": null,
  • "files": [
    ],
  • "permission": 1,
  • "sticky": 0,
  • "category_id": 0,
  • "alert": 0,
  • "alert_grid": 0,
  • "alert_to": "2019-08-24",
  • "alert_type": null,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of notes

Authorizations:
BearerAuth
path Parameters
inventory
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
page
integer
Default: 1
limit
integer
Default: 20

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get note

Authorizations:
BearerAuth
path Parameters
inventory
required
integer
note
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update note

Authorizations:
BearerAuth
path Parameters
inventory
required
integer
note
required
integer
Request Body schema: application/json
title
string
note
any
files
Array of strings or null

Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.

permission
integer
Default: 0
Enum: 1 2 3

1 - public, 2 - public (read-only), 3 - private

sticky
integer
category_id
integer or null
alert
integer
alert_grid
integer
alert_to
string or null <date>
alert_type
any
external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "note": null,
  • "files": [
    ],
  • "permission": 1,
  • "sticky": 0,
  • "category_id": 0,
  • "alert": 0,
  • "alert_grid": 0,
  • "alert_to": "2019-08-24",
  • "alert_type": null,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete note

Authorizations:
BearerAuth
path Parameters
inventory
required
integer
note
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore note

Authorizations:
BearerAuth
path Parameters
inventory
required
integer
note
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of notes

Authorizations:
BearerAuth
path Parameters
inventory
required
integer
Request Body schema: application/json
Array of objects (Note)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of notes

Authorizations:
BearerAuth
path Parameters
inventory
required
integer
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of notes

Authorizations:
BearerAuth
path Parameters
inventory
required
integer
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of notes

Authorizations:
BearerAuth
path Parameters
inventory
required
integer
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Associate note with assets inventory

Authorizations:
BearerAuth
path Parameters
inventory
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Dissociate note from assets inventory

Authorizations:
BearerAuth
path Parameters
inventory
required
integer
note
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Inventory Storage Relation Api

API documentation for Inventory Storage Relation Api

Create assets inventory storage

Authorizations:
BearerAuth
path Parameters
inventory
required
integer
Request Body schema: application/json
inventory_id
integer
type
any
Enum: "project" "warehouse"
warehouse_id
integer or null
project_id
integer or null
quantity
any
external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "inventory_id": 0,
  • "type": "project",
  • "warehouse_id": 0,
  • "project_id": 0,
  • "quantity": null,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of assets inventory storage

Authorizations:
BearerAuth
path Parameters
inventory
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
page
integer
Default: 1
limit
integer
Default: 20

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get assets inventory storage

Authorizations:
BearerAuth
path Parameters
inventory
required
integer
storage
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update assets inventory storage

Authorizations:
BearerAuth
path Parameters
inventory
required
integer
storage
required
integer
Request Body schema: application/json
inventory_id
integer
type
any
Enum: "project" "warehouse"
warehouse_id
integer or null
project_id
integer or null
quantity
any
external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "inventory_id": 0,
  • "type": "project",
  • "warehouse_id": 0,
  • "project_id": 0,
  • "quantity": null,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete assets inventory storage

Authorizations:
BearerAuth
path Parameters
inventory
required
integer
storage
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore assets inventory storage

Authorizations:
BearerAuth
path Parameters
inventory
required
integer
storage
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of assets inventory storage

Authorizations:
BearerAuth
path Parameters
inventory
required
integer
Request Body schema: application/json
Array of objects (InventoryStorage)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of assets inventory storage

Authorizations:
BearerAuth
path Parameters
inventory
required
integer
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of assets inventory storage

Authorizations:
BearerAuth
path Parameters
inventory
required
integer
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of assets inventory storage

Authorizations:
BearerAuth
path Parameters
inventory
required
integer
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Associate assets inventory storage with assets inventory

Authorizations:
BearerAuth
path Parameters
inventory
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Dissociate assets inventory storage from assets inventory

Authorizations:
BearerAuth
path Parameters
inventory
required
integer
storage
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Inventory Usage Relation Api

API documentation for Inventory Usage Relation Api

Create assets inventory usage

Authorizations:
BearerAuth
path Parameters
inventory
required
integer
Request Body schema: application/json
inventory_id
integer
storage_id
integer
quantity
any
record_type
string
Enum: "App\\Tenant\\CRM\\Models\\Contact" "App\\Tenant\\Contractor\\Project\\Models\\Project" "App\\Tenant\\Assets\\Models\\EquipmentService"
record_id
integer
purchase_id
integer or null
production_id
integer or null
total_cost
any
total_cost_currency
string or null
external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "inventory_id": 0,
  • "storage_id": 0,
  • "quantity": null,
  • "record_type": "App\\Tenant\\CRM\\Models\\Contact",
  • "record_id": 0,
  • "purchase_id": 0,
  • "production_id": 0,
  • "total_cost": null,
  • "total_cost_currency": "string",
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of assets inventory usages

Authorizations:
BearerAuth
path Parameters
inventory
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
page
integer
Default: 1
limit
integer
Default: 20

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get assets inventory usage

Authorizations:
BearerAuth
path Parameters
inventory
required
integer
usage
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update assets inventory usage

Authorizations:
BearerAuth
path Parameters
inventory
required
integer
usage
required
integer
Request Body schema: application/json
inventory_id
integer
storage_id
integer
quantity
any
record_type
string
Enum: "App\\Tenant\\CRM\\Models\\Contact" "App\\Tenant\\Contractor\\Project\\Models\\Project" "App\\Tenant\\Assets\\Models\\EquipmentService"
record_id
integer
purchase_id
integer or null
production_id
integer or null
total_cost
any
total_cost_currency
string or null
external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "inventory_id": 0,
  • "storage_id": 0,
  • "quantity": null,
  • "record_type": "App\\Tenant\\CRM\\Models\\Contact",
  • "record_id": 0,
  • "purchase_id": 0,
  • "production_id": 0,
  • "total_cost": null,
  • "total_cost_currency": "string",
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete assets inventory usage

Authorizations:
BearerAuth
path Parameters
inventory
required
integer
usage
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore assets inventory usage

Authorizations:
BearerAuth
path Parameters
inventory
required
integer
usage
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of assets inventory usages

Authorizations:
BearerAuth
path Parameters
inventory
required
integer
Request Body schema: application/json
Array of objects (InventoryUsage)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of assets inventory usages

Authorizations:
BearerAuth
path Parameters
inventory
required
integer
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of assets inventory usages

Authorizations:
BearerAuth
path Parameters
inventory
required
integer
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of assets inventory usages

Authorizations:
BearerAuth
path Parameters
inventory
required
integer
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Associate assets inventory usage with assets inventory

Authorizations:
BearerAuth
path Parameters
inventory
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Dissociate assets inventory usage from assets inventory

Authorizations:
BearerAuth
path Parameters
inventory
required
integer
usage
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Inventory Category Api

API documentation for Inventory Category Api

Create assets inventory category

Authorizations:
BearerAuth
Request Body schema: application/json
name
string
external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of assets inventory categories

Authorizations:
BearerAuth
query Parameters
with_trashed
boolean
only_trashed
boolean
page
integer
Default: 1
limit
integer
Default: 20

Responses

Response samples

Content type
application/json
{}

Get assets inventory category

Authorizations:
BearerAuth
path Parameters
inventory_category
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update assets inventory category

Authorizations:
BearerAuth
path Parameters
inventory_category
required
integer
Request Body schema: application/json
name
string
external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete assets inventory category

Authorizations:
BearerAuth
path Parameters
inventory_category
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore assets inventory category

Authorizations:
BearerAuth
path Parameters
inventory_category
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of assets inventory categories

Authorizations:
BearerAuth
Request Body schema: application/json
Array of objects (InventoryCategory)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of assets inventory categories

Authorizations:
BearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of assets inventory categories

Authorizations:
BearerAuth
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of assets inventory categories

Authorizations:
BearerAuth
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Inventory Purchase Api

API documentation for Inventory Purchase Api

Create assets inventory purchase

Authorizations:
BearerAuth
Request Body schema: application/json
vendor_id
integer
invoice_no
string or null
delivery_note
string or null
date
string <date>
memo
string or null
status
any
Enum: "price_quote" "order" "canceled" "delivered"
invoiced
integer
assign
integer
record_type
string or null
Enum: "App\\Tenant\\CRM\\Models\\Contact" "App\\Tenant\\Contractor\\Project\\Models\\Project" "App\\Tenant\\Assets\\Models\\EquipmentService"
record_id
integer or null
storage_type
any
Enum: "project" "warehouse"
warehouse_id
integer or null
project_id
integer or null
external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "vendor_id": 0,
  • "invoice_no": "string",
  • "delivery_note": "string",
  • "date": "2019-08-24",
  • "memo": "string",
  • "status": "price_quote",
  • "invoiced": 0,
  • "assign": 0,
  • "record_type": "App\\Tenant\\CRM\\Models\\Contact",
  • "record_id": 0,
  • "storage_type": "project",
  • "warehouse_id": 0,
  • "project_id": 0,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of assets inventory purchases

Authorizations:
BearerAuth
query Parameters
with_trashed
boolean
only_trashed
boolean
page
integer
Default: 1
limit
integer
Default: 20

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get assets inventory purchase

Authorizations:
BearerAuth
path Parameters
inventory_purchase
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update assets inventory purchase

Authorizations:
BearerAuth
path Parameters
inventory_purchase
required
integer
Request Body schema: application/json
vendor_id
integer
invoice_no
string or null
delivery_note
string or null
date
string <date>
memo
string or null
status
any
Enum: "price_quote" "order" "canceled" "delivered"
invoiced
integer
assign
integer
record_type
string or null
Enum: "App\\Tenant\\CRM\\Models\\Contact" "App\\Tenant\\Contractor\\Project\\Models\\Project" "App\\Tenant\\Assets\\Models\\EquipmentService"
record_id
integer or null
storage_type
any
Enum: "project" "warehouse"
warehouse_id
integer or null
project_id
integer or null
external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "vendor_id": 0,
  • "invoice_no": "string",
  • "delivery_note": "string",
  • "date": "2019-08-24",
  • "memo": "string",
  • "status": "price_quote",
  • "invoiced": 0,
  • "assign": 0,
  • "record_type": "App\\Tenant\\CRM\\Models\\Contact",
  • "record_id": 0,
  • "storage_type": "project",
  • "warehouse_id": 0,
  • "project_id": 0,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete assets inventory purchase

Authorizations:
BearerAuth
path Parameters
inventory_purchase
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore assets inventory purchase

Authorizations:
BearerAuth
path Parameters
inventory_purchase
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of assets inventory purchases

Authorizations:
BearerAuth
Request Body schema: application/json
Array of objects (InventoryPurchase)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of assets inventory purchases

Authorizations:
BearerAuth
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of assets inventory purchases

Authorizations:
BearerAuth
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of assets inventory purchases

Authorizations:
BearerAuth
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Inventory Purchase Notes Relation Api

API documentation for Inventory Purchase Notes Relation Api

Create note

Authorizations:
BearerAuth
path Parameters
inventory_purchase
required
integer
Request Body schema: application/json
title
string
note
any
files
Array of strings or null

Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.

permission
integer
Default: 0
Enum: 1 2 3

1 - public, 2 - public (read-only), 3 - private

sticky
integer
category_id
integer or null
alert
integer
alert_grid
integer
alert_to
string or null <date>
alert_type
any
external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "note": null,
  • "files": [
    ],
  • "permission": 1,
  • "sticky": 0,
  • "category_id": 0,
  • "alert": 0,
  • "alert_grid": 0,
  • "alert_to": "2019-08-24",
  • "alert_type": null,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of notes

Authorizations:
BearerAuth
path Parameters
inventory_purchase
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
page
integer
Default: 1
limit
integer
Default: 20

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get note

Authorizations:
BearerAuth
path Parameters
inventory_purchase
required
integer
note
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update note

Authorizations:
BearerAuth
path Parameters
inventory_purchase
required
integer
note
required
integer
Request Body schema: application/json
title
string
note
any
files
Array of strings or null

Array of note attachments. Each item can be an form-data upload file or a base64 payload string. Supported base64 formats: raw payload, data:mime;base64,payload, data:mime;name=filename;base64,payload, and name=filename;base64,payload.

permission
integer
Default: 0
Enum: 1 2 3

1 - public, 2 - public (read-only), 3 - private

sticky
integer
category_id
integer or null
alert
integer
alert_grid
integer
alert_to
string or null <date>
alert_type
any
external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "note": null,
  • "files": [
    ],
  • "permission": 1,
  • "sticky": 0,
  • "category_id": 0,
  • "alert": 0,
  • "alert_grid": 0,
  • "alert_to": "2019-08-24",
  • "alert_type": null,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete note

Authorizations:
BearerAuth
path Parameters
inventory_purchase
required
integer
note
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore note

Authorizations:
BearerAuth
path Parameters
inventory_purchase
required
integer
note
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of notes

Authorizations:
BearerAuth
path Parameters
inventory_purchase
required
integer
Request Body schema: application/json
Array of objects (Note)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of notes

Authorizations:
BearerAuth
path Parameters
inventory_purchase
required
integer
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of notes

Authorizations:
BearerAuth
path Parameters
inventory_purchase
required
integer
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of notes

Authorizations:
BearerAuth
path Parameters
inventory_purchase
required
integer
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Associate note with assets inventory purchase

Authorizations:
BearerAuth
path Parameters
inventory_purchase
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Dissociate note from assets inventory purchase

Authorizations:
BearerAuth
path Parameters
inventory_purchase
required
integer
note
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Inventory Purchase Row Relation Api

API documentation for Inventory Purchase Row Relation Api

Create assets inventory purchase row

Authorizations:
BearerAuth
path Parameters
inventory_purchase
required
integer
Request Body schema: application/json
purchase_id
integer
inventory_id
integer
storage_id
integer
unit_price
any
unit_price_currency
string or null
quantity
any
used_quantity
any
external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "purchase_id": 0,
  • "inventory_id": 0,
  • "storage_id": 0,
  • "unit_price": null,
  • "unit_price_currency": "string",
  • "quantity": null,
  • "used_quantity": null,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a list of assets inventory purchase rows

Authorizations:
BearerAuth
path Parameters
inventory_purchase
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean
page
integer
Default: 1
limit
integer
Default: 20

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "links": {},
  • "meta": {
    }
}

Get assets inventory purchase row

Authorizations:
BearerAuth
path Parameters
inventory_purchase
required
integer
row
required
integer
query Parameters
with_trashed
boolean
only_trashed
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update assets inventory purchase row

Authorizations:
BearerAuth
path Parameters
inventory_purchase
required
integer
row
required
integer
Request Body schema: application/json
purchase_id
integer
inventory_id
integer
storage_id
integer
unit_price
any
unit_price_currency
string or null
quantity
any
used_quantity
any
external_id
string or null

Responses

Request samples

Content type
application/json
{
  • "purchase_id": 0,
  • "inventory_id": 0,
  • "storage_id": 0,
  • "unit_price": null,
  • "unit_price_currency": "string",
  • "quantity": null,
  • "used_quantity": null,
  • "external_id": "string"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Delete assets inventory purchase row

Authorizations:
BearerAuth
path Parameters
inventory_purchase
required
integer
row
required
integer
query Parameters
force
boolean

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Restore assets inventory purchase row

Authorizations:
BearerAuth
path Parameters
inventory_purchase
required
integer
row
required
integer

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Create a batch of assets inventory purchase rows

Authorizations:
BearerAuth
path Parameters
inventory_purchase
required
integer
Request Body schema: application/json
Array of objects (InventoryPurchaseRow)

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Update a batch of assets inventory purchase rows

Authorizations:
BearerAuth
path Parameters
inventory_purchase
required
integer
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "resources": {
    }
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Delete a batch of assets inventory purchase rows

Authorizations:
BearerAuth
path Parameters
inventory_purchase
required
integer
query Parameters
force
boolean
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Restore a batch of assets inventory purchase rows

Authorizations:
BearerAuth
path Parameters
inventory_purchase
required
integer
Request Body schema: application/json
resources
Array of integers

Responses

Request samples

Content type
application/json
{
  • "resources": [
    ]
}

Response samples

Content type
application/json
{
  • "data": [