Skip to main content
API docs by Redocly

RESTful API for Cirrus 2 (0.3.73)

Download OpenAPI specification:Download

An open RESTful API for Cirrus 2 integration

accounts

Operations related to accounts

Creates a new account

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
name
required
string

This field can not be empty.

alt_name
string
typeid
required
integer
number
string
userid
required
integer
alternateuserid
integer
phone
string
cellphone
string
fax
string
email
string
url
string
vatno
string
active
integer
info
string
socialmedia_fb
string
socialmedia_tw
string
socialmedia_li
string
uservisitintervalweeks
integer
alternateuservisitintervalweeks
integer
parentaccountid
integer
object (Addresses)
Array of objects (AccountGroup)
externalkey
string
Array of objects (IdObject)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "alt_name": "string",
  • "typeid": 0,
  • "number": "string",
  • "userid": 0,
  • "alternateuserid": 0,
  • "phone": "string",
  • "cellphone": "string",
  • "fax": "string",
  • "email": "string",
  • "url": "string",
  • "vatno": "string",
  • "active": 0,
  • "info": "string",
  • "socialmedia_fb": "string",
  • "socialmedia_tw": "string",
  • "socialmedia_li": "string",
  • "uservisitintervalweeks": 0,
  • "alternateuservisitintervalweeks": 0,
  • "parentaccountid": 0,
  • "addresses": {
    },
  • "accountgroups": [
    ],
  • "externalkey": "string",
  • "tags": [
    ]
}

Returns a paginated list of accounts

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

dynamicfield_id
Array of integers

Query by dynamicfield value. Each dynamicfield_id must be paired with a dynamicfield_val parameter in order to filter

dynamicfield_val
Array of strings

Query by dynamicfield value. Each dynamicfield_val must be paired with a dynamicfield_id parameter in order to filter

userid
integer

id property of the user owning the account

userids
string

comma separated list of userids

accountnumber
string

number property of the account whith which the account takes place

typeid
integer

id property of the accountType

typeids
integer

comma separated list of typeids

active
integer
Default: 1
Enum: 0 1 2

get active or inactive accounts, use the value 2 for both active and inactive

name
string

use % as a wildcard

nearto
string

will filter accounts based on proximty to supplied location {latitude, longitude}

distance
string

determines the proximity treshold for the nearto filter, treshold is in kilometers

postal_city
string

use % as a wildcard

postal_street
string

use % as a wildcard

visitingaddress_city
string

use % as a wildcard

deliveryaddress_city
string

use % as a wildcard

invoiceaddress_city
string

use % as a wildcard

phone
string

use % as a wildcard

cellphone
string

use % as a wildcard

vatno
string

use % as a wildcard

externalkey
string
followedby
integer

id property of the user whose followed accounts are queried

missionid
integer
missionresult
integer
Enum: 0 1

only shows accounts connected to missionid with result 1/0

activity
integer
Enum: 0 1

Show accounts with at least one activity. use activity_* for more activity predicates

activity_user
integer

Show accounts with at least one activity where this user is responsible. Only in effect when activity=1.

activity_closed
integer
Enum: 0 1

Show accounts with at least one (non-)closed activity if set to true. Only in effect when activity=1.

activity_type
integer

Show accounts with at least one activity of this type. Only in effect when activity=1.

fulltext
string

this property will be used in a search in name, alt_name, number, phone, cellphone, email, vatno, postal_street, postal_city, postal_zip, visitingaddress_careof, visitingaddress_street, visitingaddress_zip, visitingaddress_city, deliveryaddress_name, deliveryaddress_street, deliveryaddress_zip, deliveryaddress_city, invoiceaddress_name, invoiceaddress_street, invoiceaddress_zip, invoiceaddress_city

sorting
required
string
Default: "name_asc"
Enum: "name_asc" "name_desc" "number_asc" "number_desc" "userid_asc" "userid_desc" "postaladdress_number_asc" "postaladdress_number_desc" "postaladdress_odd_asc" "postaladdress_odd_desc" "postaladdress_even_asc" "postaladdress_even_desc"
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a paginated list of account coordinates

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}

userid
integer

id property of the user owning the account

userids
string

comma separated list of userids

accountnumber
string

number property of the account whith which the account takes place

typeid
integer

id property of the accountType

typeids
integer

comma separated list of typeids

active
integer
Default: 1
Enum: 0 1

get active or inactive accounts

name
string

use % as a wildcard

nearto
string

will filter accounts based on proximty to supplied location {latitude, longitude}

distance
string

determines the proximity treshold for the nearto filter, treshold is in kilometers

postal_city
string

use % as a wildcard

visitingaddress_city
string

use % as a wildcard

deliveryaddress_city
string

use % as a wildcard

invoiceaddress_city
string

use % as a wildcard

phone
string

use % as a wildcard

cellphone
string

use % as a wildcard

vatno
string

use % as a wildcard

externalkey
string
followedby
integer

id property of the user whose followed accounts are queried

fulltext
string

this property will be used in a search in name, alt_name, number, phone, cellphone, email, vatno, postal_street, postal_city, postal_zip, visitingaddress_careof, visitingaddress_street, visitingaddress_zip, visitingaddress_city, deliveryaddress_name, deliveryaddress_street, deliveryaddress_zip, deliveryaddress_city, invoiceaddress_name, invoiceaddress_street, invoiceaddress_zip, invoiceaddress_city

sorting
required
string
Default: "name_asc"
Enum: "name_asc" "name_desc" "number_asc" "number_desc" "userid_asc" "userid_desc"
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a new accountgroup

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
id
integer
name
required
string

Responses

Request samples

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

Returns a paginated list of accountgroups

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

accountid
integer

this property will filter all accountgroups by accountid

fulltext
string

this property will be used in a search in name

sorting
required
string
Default: "name_asc"
Enum: "name_asc" "name_desc"
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates an accountgroup

Use this method to change root level properties of an accountgroup.

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
id
integer
name
required
string

Responses

Request samples

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

Deletes an accountgroup

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Returns an accountgroup

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

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

DEPRECATED, Returns a list of accounttypes

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Follows an account

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

Request Body schema: application/json
required
key
required
integer
userid
required
integer

Responses

Request samples

Content type
application/json
{
  • "key": 0,
  • "userid": 0
}

Unfollows an account

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

Request Body schema: application/json
required
key
required
integer
userid
required
integer

Responses

Request samples

Content type
application/json
{
  • "key": 0,
  • "userid": 0
}

put_budget_item

Authorizations:
OAuth2X-Token
path Parameters
accountid
required
integer
year
required
integer
month
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
budget
integer

The budget assiged to the account for the year/month period.

Responses

Request samples

Content type
application/json
{
  • "budget": 0
}

delete_budget_item

Authorizations:
OAuth2X-Token
path Parameters
accountid
required
integer
year
required
integer
month
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

get_budget_item

Authorizations:
OAuth2X-Token
path Parameters
accountid
required
integer
year
required
integer
month
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "year": 0,
  • "month": 0,
  • "budget": 0
}

Updates an account

Use this method to change root level properties of an account.

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
name
string
alt_name
string
typeid
integer
number
string
userid
integer
alternateuserid
integer
phone
string
cellphone
string
fax
string
email
string
url
string
vatno
string
active
integer
info
string
socialmedia_fb
string
socialmedia_tw
string
socialmedia_li
string
uservisitintervalweeks
integer
alternateuservisitintervalweeks
integer
parentaccountid
integer
object (Addresses)
Array of objects (AccountGroup)
externalkey
string
Array of objects (IdObject)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "alt_name": "string",
  • "typeid": 0,
  • "number": "string",
  • "userid": 0,
  • "alternateuserid": 0,
  • "phone": "string",
  • "cellphone": "string",
  • "fax": "string",
  • "email": "string",
  • "url": "string",
  • "vatno": "string",
  • "active": 0,
  • "info": "string",
  • "socialmedia_fb": "string",
  • "socialmedia_tw": "string",
  • "socialmedia_li": "string",
  • "uservisitintervalweeks": 0,
  • "alternateuservisitintervalweeks": 0,
  • "parentaccountid": 0,
  • "addresses": {
    },
  • "accountgroups": [
    ],
  • "externalkey": "string",
  • "tags": [
    ]
}

Deletes an account

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Returns an account

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "alt_name": "string",
  • "number": "string",
  • "phone": "string",
  • "cellphone": "string",
  • "fax": "string",
  • "email": "string",
  • "url": "string",
  • "vatno": "string",
  • "active": 0,
  • "info": "string",
  • "socialmedia_fb": "string",
  • "socialmedia_tw": "string",
  • "socialmedia_li": "string",
  • "department": "string",
  • "externalkey": "string",
  • "uservisitintervalweeks": 0,
  • "alternateuservisitintervalweeks": 0,
  • "addresses": {
    },
  • "files": [
    ],
  • "type": {
    },
  • "user": {
    },
  • "parentaccount": {
    },
  • "contacts": [
    ],
  • "followers": [
    ],
  • "accountgroups": [
    ],
  • "tags": [
    ],
  • "alternateuserid": "string",
  • "alternateuser": {
    }
}

Merges two account

Authorizations:
OAuth2X-Token
path Parameters
target
required
integer
source
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

activities

Operations related to activities

Creates a new activity

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
id
integer

The unique identifier of an Activity

object (ListedAccount)
accountid
required
integer

The unique identifier of the Account to which the Activity belongs

closed
integer

Is the Activity closed or open

Array of objects (ActivityAttempt)
description
required
string

The description of the Activity

date
string <date>

Date for when the Activity is scheduled

extrasexternalid
integer
Array of objects (ListedFile)
Array of objects (ListedUser)
Array of objects (ListedUser)
Array of objects (ListedContact)
location
required
string

Location of the activity

required
object (PrimaryContact)
object (ActivityPriority)
object (ProgressionState)
object (ListedOpportunity)
object (ActivityReminder)
start
string <date-time>

The time when the Activity starts

starttime
string

The time when the Activity starts

stop
string <date-time>

End time of the Activity

stoptime
string

End time of the Activity

result
required
string
required
object (ListedActivityType)
Array of objects (ListedUser)
userid
required
integer

The unique identifier of the owning User

Array of objects (ActivityTypeAnswer)
externalkey
string
Array of objects (Tag)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "account": {
    },
  • "accountid": 0,
  • "closed": 0,
  • "contactattempts": [
    ],
  • "description": "string",
  • "date": "2019-08-24",
  • "extrasexternalid": 0,
  • "files": [
    ],
  • "followers": [
    ],
  • "invitedusers": [
    ],
  • "invitedcontacts": [
    ],
  • "location": "string",
  • "primarycontact": {
    },
  • "priority": {
    },
  • "progressionstate": {
    },
  • "opportunity": {
    },
  • "reminder": {
    },
  • "start": "2019-01-25T00:00:00.000Z",
  • "starttime": "string",
  • "stop": "2019-01-25T00:00:00.000Z",
  • "stoptime": "string",
  • "result": "string",
  • "type": {
    },
  • "user": [
    ],
  • "userid": 0,
  • "answers": [
    ],
  • "externalkey": "string",
  • "tags": [
    ]
}

Returns a paginated list of activities

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

dynamicfield_id
Array of integers

Query by dynamicfield value. Each dynamicfield_id must be paired with a dynamicfield_val parameter in order to filter

dynamicfield_val
Array of strings

Query by dynamicfield value. Each dynamicfield_val must be paired with a dynamicfield_id parameter in order to filter

accountid
integer

id property of the account with which the appointment takes place

accounttypeids
string

Comma separated list of AccountType.id whose contacts are queried

accountuserids
string

Comma separated list of User.id of the user responsible for the Accounts whose contacts are queried

date
string

date formatted(YYYY-MM-DD) for when the appointment takes place

startdate
string

date formatted(YYYY-MM-DD) start of a date range for appointments

enddate
string

date formatted(YYYY-MM-DD) end of a date range for appointments

closed
integer
Enum: 0 1

get open or closed appointments

userid
integer

id property of the user owning the appointment

userids
string

comma separated list of userids

missionids
string

comma separated list of missionids

typeid
integer

id property of the AppointmentType

typeids
string

comma separated list of typeids

contactid
integer

id property of the contact with which the appointment takes place

opportunityid
integer

id property of the opportunity to which the appointment belongs

location
string

use % as a wildcard

description
string

use % as a wildcard

progressionstateid
integer

id propterty of the ProgressionState object

followedby
integer

id property of the user whose followed activities are queried

fulltext
string

this property will be used in a search in description, date, result and location

sorting
required
string
Default: "date_desc"
Enum: "date_asc" "date_desc" "account_asc" "account_desc" "userid_asc" "userid_desc"
externalkey
string
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a paginated list of activity coordinates

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}

accountid
integer

id property of the account with which the appointment takes place

accounttypeids
string

Comma separated list of AccountType.id whose contacts are queried

accountuserids
string

Comma separated list of User.id of the user responsible for the Accounts whose contacts are queried

date
string

date formatted(YYYY-MM-DD) for when the appointment takes place

startdate
string

date formatted(YYYY-MM-DD) start of a date range for appointments

enddate
string

date formatted(YYYY-MM-DD) end of a date range for appointments

closed
integer
Enum: 0 1

get open or closed appointments

userid
integer

id property of the user owning the appointment

userids
string

comma separated list of userids

typeid
integer

id property of the AppointmentType

typeids
string

comma separated list of typeids

contactid
integer

id property of the contact with which the appointment takes place

opportunityid
integer

id property of the opportunity to which the appointment belongs

location
string

use % as a wildcard

description
string

use % as a wildcard

progressionstateid
integer

id propterty of the ProgressionState object

followedby
integer

id property of the user whose followed activities are queried

fulltext
string

this property will be used in a search in description, date, result and location

sorting
required
string
Default: "date_desc"
Enum: "date_asc" "date_desc" "account_asc" "account_desc" "userid_asc" "userid_desc"
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a new activitytype

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a list of activitytypes

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a list of activitytypequestions

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates an activitytype

Use this method to change root level properties of an activity.

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
id
integer
name
string
value
integer
icon
integer
sortorder
integer
default
integer
quick
integer
defaultdescription
string
defaultresult
string
userfollowups
integer
alternateuserfollowups
integer

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "value": 0,
  • "icon": 0,
  • "sortorder": 0,
  • "default": 0,
  • "quick": 0,
  • "defaultdescription": "string",
  • "defaultresult": "string",
  • "userfollowups": 0,
  • "alternateuserfollowups": 0
}

Deletes an activitytype

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Returns an activitytype

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "value": 0,
  • "icon": 0,
  • "sortorder": 0,
  • "default": 0,
  • "quick": 0,
  • "defaultdescription": "string",
  • "defaultresult": "string",
  • "userfollowups": 0,
  • "alternateuserfollowups": 0
}

Follows an activity

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

Request Body schema: application/json
required
key
required
integer
userid
required
integer

Responses

Request samples

Content type
application/json
{
  • "key": 0,
  • "userid": 0
}

Returns a list of progressionstates for activities

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Unfollows an activity

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

Request Body schema: application/json
required
key
required
integer
userid
required
integer

Responses

Request samples

Content type
application/json
{
  • "key": 0,
  • "userid": 0
}

Updates an activity

Use this method to change root level properties of an activity.

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
closed
integer

Is the Activity closed or open

date
string <date>

Date 'YYYY-MM-DD' for when the Activity is scheduled

description
string

The description of the Activity

location
string

Location of the activity

result
string
starttime
string

The time 'HH:MM' when the Activity starts

stoptime
string

End time 'HH:MM' of the Activity

typeid
integer

The unique id for the ActivityType for the Activity

opportunityid
integer
userid
integer

The unique identifier of the owning User

object

Optional way of providing user owning the activity

object (PrimaryContact)
Array of objects (ListedUser)
Array of objects (ListedContact)
Array of objects (ActivityTypeAnswer)
Array of objects (IdObject)

Responses

Request samples

Content type
application/json
{
  • "closed": 0,
  • "date": "2019-08-24",
  • "description": "string",
  • "location": "string",
  • "result": "string",
  • "starttime": "string",
  • "stoptime": "string",
  • "typeid": 0,
  • "opportunityid": 0,
  • "userid": 0,
  • "user": {
    },
  • "primarycontact": {
    },
  • "invitedusers": [
    ],
  • "invitedcontacts": [
    ],
  • "answers": [
    ],
  • "tags": [
    ]
}

Deletes an activity

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Returns an activity

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "account": {
    },
  • "accountid": 0,
  • "closed": 0,
  • "contactattempts": [
    ],
  • "description": "string",
  • "date": "2019-08-24",
  • "extrasexternalid": 0,
  • "files": [
    ],
  • "followers": [
    ],
  • "invitedusers": [
    ],
  • "invitedcontacts": [
    ],
  • "location": "string",
  • "primarycontact": {
    },
  • "priority": {
    },
  • "progressionstate": {
    },
  • "opportunity": {
    },
  • "reminder": {
    },
  • "start": "2019-01-25T00:00:00.000Z",
  • "starttime": "string",
  • "stop": "2019-01-25T00:00:00.000Z",
  • "stoptime": "string",
  • "result": "string",
  • "type": {
    },
  • "user": [
    ],
  • "userid": 0,
  • "answers": [
    ],
  • "externalkey": "string",
  • "tags": [
    ]
}

articlegroups

Operations related to articlegroups

Creates a new articlegroup

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
id
integer
name
string
externalkey
string
sortorder
integer
Default: 0

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "externalkey": "string",
  • "sortorder": 0
}

Returns a paginated list of articlegroups

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

externalkey
string
name
string

this property will match groups with a name that begins with the supplied text

sorting
required
string
Default: "name_asc"
Enum: "name_asc" "name_desc" "id_asc" "id_desc" "sort_asc" "sort_desc"
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates an articlegroup

Use this method to change root level properties of an articlegroup.

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
id
integer
name
string
externalkey
string
sortorder
integer
Default: 0

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "externalkey": "string",
  • "sortorder": 0
}

Deletes an articlegroup

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Returns a article

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "externalkey": "string",
  • "sortorder": 0
}

articles

Operations related to articles

Creates a new article

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
name
required
string
price
required
number
description
required
string
warehousestatusid
integer
businessareaid
integer
servicelevelid
integer
warehouseid
integer
unitid
integer
groupid
integer
number
string
buyprice
number
commision
number
externalkey
string
imageurl
string
url1
string
url2
string
stockbalance
integer
vat
required
number
accountid
integer
suppliername
string
supplierarticlenumber
string
stockbalancewarningtreshold
integer
brandid
integer
materialid
integer
incampaign
integer
volume
integer
area
number
volumegroupid
integer
discountgroupid
integer
budgetgroupid
integer
active
integer
presentation
string
discount
number
sortorder
integer
Default: 0
Array of objects (IdObject)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "price": 0,
  • "description": "string",
  • "warehousestatusid": 0,
  • "businessareaid": 0,
  • "servicelevelid": 0,
  • "warehouseid": 0,
  • "unitid": 0,
  • "groupid": 0,
  • "number": "string",
  • "buyprice": 0,
  • "commision": 0,
  • "externalkey": "string",
  • "imageurl": "string",
  • "url1": "string",
  • "url2": "string",
  • "stockbalance": 0,
  • "vat": 0,
  • "accountid": 0,
  • "suppliername": "string",
  • "supplierarticlenumber": "string",
  • "stockbalancewarningtreshold": 0,
  • "brandid": 0,
  • "materialid": 0,
  • "incampaign": 0,
  • "volume": 0,
  • "area": 0,
  • "volumegroupid": 0,
  • "discountgroupid": 0,
  • "budgetgroupid": 0,
  • "active": 0,
  • "presentation": "string",
  • "discount": 0,
  • "sortorder": 0,
  • "tags": [
    ]
}

Returns a paginated list of articles

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

dynamicfield_id
Array of integers

Query by dynamicfield value. Each dynamicfield_id must be paired with a dynamicfield_val parameter in order to filter

dynamicfield_val
Array of strings

Query by dynamicfield value. Each dynamicfield_val must be paired with a dynamicfield_id parameter in order to filter

number
string

query articles by number

groupid
string

query articles by id property of the ArticleGroup

active
integer
Enum: 0 1

get active or inactive articles

supplierarticlenumber
string

get active or inactive articles

warehousestatusid
integer
businessareaid'
integer
servicelevelid
integer
warehouseid
integer
unitid
integer
externalkey
string
brandid
integer
materialid
integer
volumegroupid
integer
discountgroupid
integer
budgetgroupid
integer
missionid
integer
fulltext
string

this property will be used in a search in title, description and result

sorting
required
string
Default: "number_asc"
Enum: "name_asc" "name_desc" "number_asc" "number_desc" "suppliername_asc" "suppliername_desc" "supplierarticlenumber_asc" "supplierarticlenumber_desc" "externalkey_asc" "externalkey_desc" "sort_asc" "sort_desc"
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a list of brands

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a list of budgetgroups

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a list of discountgroups

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

DEPRECATED Returns a list of articlegroups

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a list of materials

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a list of servicelevels

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a list of articleunits

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a list of volumegroups

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a list of warehouses

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a list of warehousestatuses

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates a article

Use this method to change root level properties of a article.

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
name
required
string
price
required
number
description
required
string
warehousestatusid
integer
businessareaid
integer
servicelevelid
integer
warehouseid
integer
unitid
integer
groupid
integer
number
string
buyprice
number
commision
number
externalkey
string
imageurl
string
url1
string
url2
string
stockbalance
integer
vat
required
number
accountid
integer
suppliername
string
supplierarticlenumber
string
stockbalancewarningtreshold
integer
brandid
integer
materialid
integer
incampaign
integer
volume
integer
area
number
volumegroupid
integer
discountgroupid
integer
budgetgroupid
integer
active
integer
presentation
string
discount
number
sortorder
integer
Default: 0
Array of objects (IdObject)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "price": 0,
  • "description": "string",
  • "warehousestatusid": 0,
  • "businessareaid": 0,
  • "servicelevelid": 0,
  • "warehouseid": 0,
  • "unitid": 0,
  • "groupid": 0,
  • "number": "string",
  • "buyprice": 0,
  • "commision": 0,
  • "externalkey": "string",
  • "imageurl": "string",
  • "url1": "string",
  • "url2": "string",
  • "stockbalance": 0,
  • "vat": 0,
  • "accountid": 0,
  • "suppliername": "string",
  • "supplierarticlenumber": "string",
  • "stockbalancewarningtreshold": 0,
  • "brandid": 0,
  • "materialid": 0,
  • "incampaign": 0,
  • "volume": 0,
  • "area": 0,
  • "volumegroupid": 0,
  • "discountgroupid": 0,
  • "budgetgroupid": 0,
  • "active": 0,
  • "presentation": "string",
  • "discount": 0,
  • "sortorder": 0,
  • "tags": [
    ]
}

Deletes a article

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Returns a article

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "price": 0,
  • "description": "string",
  • "warehousestatusid": 0,
  • "businessareaid": 0,
  • "servicelevelid": 0,
  • "warehouseid": 0,
  • "unitid": 0,
  • "groupid": 0,
  • "number": "string",
  • "buyprice": 0,
  • "commision": 0,
  • "externalkey": "string",
  • "imageurl": "string",
  • "url1": "string",
  • "url2": "string",
  • "stockbalance": 0,
  • "vat": 0,
  • "accountid": 0,
  • "suppliername": "string",
  • "supplierarticlenumber": "string",
  • "stockbalancewarningtreshold": 0,
  • "brandid": 0,
  • "materialid": 0,
  • "incampaign": 0,
  • "volume": 0,
  • "area": 0,
  • "volumegroupid": 0,
  • "discountgroupid": 0,
  • "budgetgroupid": 0,
  • "active": 0,
  • "presentation": "string",
  • "discount": 0,
  • "sortorder": 0,
  • "tags": [
    ]
}

articleunits

Operations related to articleunits

Creates a new article

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
id
integer
name
string
externalkey
string

Responses

Request samples

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

Returns a paginated list of articleunits

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

externalkey
string
name
string

this property will match units with a name that begins with the supplied text

sorting
required
string
Default: "name_asc"
Enum: "name_asc" "name_desc" "id_asc" "id_desc"
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates an articleunit

Use this method to change root level properties of an articleunit.

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
id
integer
name
string
externalkey
string

Responses

Request samples

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

Deletes an articleunit

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Returns a article

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

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

contacts

Operations related to contacts

Creates a new contact

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
name
required
string

This field must not be empty.

surname
required
string

This field must not be empty.

function
string
department
string
email
string
officephone
string
cellphone
string
title
string
street
string
city
string
zip
string
accountid
required
integer
primarycontact
integer
socialmedia_fb
string
socialmedia_tw
string
socialmedia_li
string
idnumber
string
externalkey
string
active
integer
superiorid
integer
Array of objects (IdObject)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "surname": "string",
  • "function": "string",
  • "department": "string",
  • "email": "string",
  • "officephone": "string",
  • "cellphone": "string",
  • "title": "string",
  • "street": "string",
  • "city": "string",
  • "zip": "string",
  • "accountid": 0,
  • "primarycontact": 0,
  • "socialmedia_fb": "string",
  • "socialmedia_tw": "string",
  • "socialmedia_li": "string",
  • "idnumber": "string",
  • "externalkey": "string",
  • "active": 0,
  • "superiorid": 0,
  • "tags": [
    ]
}

Returns a paginated list of contacts

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

dynamicfield_id
Array of integers

Query by dynamicfield value. Each dynamicfield_id must be paired with a dynamicfield_val parameter in order to filter

dynamicfield_val
Array of strings

Query by dynamicfield value. Each dynamicfield_val must be paired with a dynamicfield_id parameter in order to filter

accountid
integer

Contact.id with which the Contact takes place

accounttypeids
string

Comma separated list of AccountType.id whose contacts are queried

accountuserids
string

Comma separated list of User.id of the user responsible for the Accounts whose contacts are queried

active
integer
Enum: 0 1

get active or inactive contacts

cellphone
string

use % as a wildcard

city
string

use % as a wildcard

email
string

use % as a wildcard

externalkey
string
followedby
integer

User.id whose followed accounts are queried

fulltext
string

this property will be used in a search in name, surname, email, officephone, cellphone, title, idnumber, street, city, zip

name
string

use % as a wildcard

officephone
string

use % as a wildcard

surname
string

use % as a wildcard

title
string

use % as a wildcard

primarycontact
integer
Enum: 0 1

get marked as primarycontact or not primarycontact contacts

sorting
required
string
Default: "name_asc"
Enum: "name_asc" "name_desc" "surname_asc" "surname_desc" "email_asc" "email_desc" "primarycontact_asc" "primarycontact_desc"
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Follows a contact

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

Request Body schema: application/json
required
key
required
integer
userid
required
integer

Responses

Request samples

Content type
application/json
{
  • "key": 0,
  • "userid": 0
}

Unfollows a contact

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

Request Body schema: application/json
required
key
required
integer
userid
required
integer

Responses

Request samples

Content type
application/json
{
  • "key": 0,
  • "userid": 0
}

Updates a contact

Use this method to change root level properties of a contact.

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
name
string
surname
string
function
string
department
string
email
string
officephone
string
cellphone
string
title
string
street
string
city
string
zip
string
primarycontact
integer
socialmedia_fb
string
socialmedia_tw
string
socialmedia_li
string
idnumber
string
externalkey
string
active
integer
superiorid
integer
Array of objects (IdObject)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "surname": "string",
  • "function": "string",
  • "department": "string",
  • "email": "string",
  • "officephone": "string",
  • "cellphone": "string",
  • "title": "string",
  • "street": "string",
  • "city": "string",
  • "zip": "string",
  • "primarycontact": 0,
  • "socialmedia_fb": "string",
  • "socialmedia_tw": "string",
  • "socialmedia_li": "string",
  • "idnumber": "string",
  • "externalkey": "string",
  • "active": 0,
  • "superiorid": 0,
  • "tags": [
    ]
}

Deletes a contact

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Returns a contact

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "account": {
    },
  • "name": "string",
  • "surname": "string",
  • "function": "string",
  • "department": "string",
  • "email": "string",
  • "officephone": "string",
  • "cellphone": "string",
  • "title": "string",
  • "street": "string",
  • "city": "string",
  • "zip": "string",
  • "primarycontact": 0,
  • "socialmedia_fb": "string",
  • "socialmedia_tw": "string",
  • "socialmedia_li": "string",
  • "idnumber": "string",
  • "externalkey": "string",
  • "active": 0,
  • "superior": {
    },
  • "files": [
    ],
  • "followers": [
    ],
  • "photo": {
    },
  • "tags": [
    ]
}

deliveryterms

Operations related to deliveryterms

Creates a new deliveryterm

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
id
integer
name
required
string
default
integer
externalkey
required
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "default": 0,
  • "externalkey": "string"
}

Returns a paginated list of deliveryterms

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

name
string
default
integer
externalkey
string
sorting
required
string
Default: "name_asc"
Enum: "name_asc" "name_desc" "id_asc" "id_desc"
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates an deliveryterm

Use this method to change root level properties of an deliveryterm.

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
id
integer
name
required
string
default
integer
externalkey
required
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "default": 0,
  • "externalkey": "string"
}

Deletes an deliveryterm

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Returns a article

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "default": 0,
  • "externalkey": "string"
}

deliverytypes

Operations related to deliverytypes

Creates a new deliverytype

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
id
integer
name
required
string
default
integer

Responses

Request samples

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

Returns a paginated list of deliverytypes

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

name
string
default
integer
sorting
required
string
Default: "name_asc"
Enum: "name_asc" "name_desc" "id_asc" "id_desc"
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates an deliverytype

Use this method to change root level properties of an deliverytype.

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
id
integer
name
required
string
default
integer

Responses

Request samples

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

Deletes an deliverytype

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Returns a article

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

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

dynamicfields

Operations related to dynamic field definitions

Returns a paginated list of dynamic fields

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

groups
Array of strings

comma separated list of groups [account, contact, order, opportunity, article]

typeid
integer
fieldname
string
sorting
required
string
Default: "sorting_asc"
Enum: "name_asc" "name_desc" "sorting_asc" "sorting_desc" "groupname_asc" "groupname_desc"
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get_field_definition_item

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "group": "string",
  • "sortorder": 0,
  • "size": 0,
  • "help": "string",
  • "required": true,
  • "inoverview": true,
  • "visible": true,
  • "readonly": true,
  • "options": [
    ],
  • "type": {
    },
  • "fieldgroup": {
    },
  • "selected": [
    ],
  • "unselected": [
    ]
}

Returns a paginated list of dynamic data for a given resource

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

resourcetype
required
string
Enum: "account" "contact" "order" "quote" "opportunity" "activity" "article"
resourceid
required
integer
fieldname
string
fieldids
Array of integers
sorting
required
string
Default: "sorting_asc"
Enum: "name_asc" "name_desc" "sorting_asc" "sorting_desc"
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates the value(s) of a dynamic data object for a given resource

Authorizations:
OAuth2X-Token
path Parameters
fieldid
required
integer
resourceid
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
Array of objects (FieldType)
Array of objects (FieldType)
value
string

Responses

Request samples

Content type
application/json
{
  • "selected": [
    ],
  • "unselected": [
    ],
  • "value": "string"
}

files

Operations related to files

Creates a new file

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
name
required
string
info
string
folderid
integer
content
required
string

base64 representation of the file content.

connectedactivities
Array of integers

this is a list of Activity.id to which the file will be connected

connectedaccounts
Array of integers

this is a list of Account.id to which the file will be connected

connectedcontacts
Array of integers

this is a list of Contact.id to which the file will be connected

connectedopportunities
Array of integers

this is a list of Opportunity.id to which the file will be connected

connectedorders
Array of integers

this is a list of Order.id to which the file will be connected

connectedleads
Array of integers

this is a list of Lead.id to which the file will be connected

connectedquotes
Array of integers

this is a list of Quote.id to which the file will be connected

connectedprojects
Array of integers

this is a list of Project.id to which the file will be connected

connectedobjects
Array of integers

this is a list of Object.id to which the file will be connected

connectedusers
Array of integers

this is a list of User.id to which the file will be connected

connectedarticles
Array of integers

this is a list of Article.id to which the file will be connected

connectedmissions
Array of integers

this is a list of Mission.id to which the file will be connected

connectedsubscriptions
Array of integers

this is a list of Subscription.id to which the file will be connected

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "info": "string",
  • "folderid": 0,
  • "content": "string",
  • "connectedactivities": [
    ],
  • "connectedaccounts": [
    ],
  • "connectedcontacts": [
    ],
  • "connectedopportunities": [
    ],
  • "connectedorders": [
    ],
  • "connectedleads": [
    ],
  • "connectedquotes": [
    ],
  • "connectedprojects": [
    ],
  • "connectedobjects": [
    ],
  • "connectedusers": [
    ],
  • "connectedarticles": [
    ],
  • "connectedmissions": [
    ],
  • "connectedsubscriptions": [
    ]
}

Returns a paginated list of files

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

activityid
integer
articleid
integer
accountid
integer
contactid
integer
opportunityid
integer
quoteid
integer
orderid
integer
leadid
integer
projectid
integer
objectid
integer
userid
integer
missionid
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a paginated list of folders

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

folderid
integer
accountid
integer
parentfolderid
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a folder

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "parentfolderid": 0,
  • "accountid": 0,
  • "files": [
    ],
  • "account": {
    },
  • "folders": [
    ]
}

Updates a file

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
name
required
string
info
string
folderid
integer
content
required
string

base64 representation of the file content.

connectedactivities
Array of integers

this is a list of Activity.id to which the file will be connected

connectedaccounts
Array of integers

this is a list of Account.id to which the file will be connected

connectedcontacts
Array of integers

this is a list of Contact.id to which the file will be connected

connectedopportunities
Array of integers

this is a list of Opportunity.id to which the file will be connected

connectedorders
Array of integers

this is a list of Order.id to which the file will be connected

connectedleads
Array of integers

this is a list of Lead.id to which the file will be connected

connectedquotes
Array of integers

this is a list of Quote.id to which the file will be connected

connectedprojects
Array of integers

this is a list of Project.id to which the file will be connected

connectedobjects
Array of integers

this is a list of Object.id to which the file will be connected

connectedusers
Array of integers

this is a list of User.id to which the file will be connected

connectedarticles
Array of integers

this is a list of Article.id to which the file will be connected

connectedmissions
Array of integers

this is a list of Mission.id to which the file will be connected

connectedsubscriptions
Array of integers

this is a list of Subscription.id to which the file will be connected

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "info": "string",
  • "folderid": 0,
  • "content": "string",
  • "connectedactivities": [
    ],
  • "connectedaccounts": [
    ],
  • "connectedcontacts": [
    ],
  • "connectedopportunities": [
    ],
  • "connectedorders": [
    ],
  • "connectedleads": [
    ],
  • "connectedquotes": [
    ],
  • "connectedprojects": [
    ],
  • "connectedobjects": [
    ],
  • "connectedusers": [
    ],
  • "connectedarticles": [
    ],
  • "connectedmissions": [
    ],
  • "connectedsubscriptions": [
    ]
}

Deletes a file

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Returns a file object

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "info": "string",
  • "timestamp": "string",
  • "folderid": 0,
  • "templateid": 0,
  • "folder": {
    },
  • "template": {
    },
  • "activities": [
    ],
  • "accounts": [
    ],
  • "contacts": [
    ],
  • "opportunities": [
    ],
  • "connectedactivities": [
    ],
  • "connectedaccounts": [
    ],
  • "connectedcontacts": [
    ],
  • "connectedopportunities": [
    ],
  • "connectedorders": [
    ],
  • "connectedleads": [
    ],
  • "connectedquotes": [
    ],
  • "connectedprojects": [
    ],
  • "connectedobjects": [
    ],
  • "connectedusers": [
    ],
  • "connectedarticles": [
    ],
  • "connectedmissions": [
    ],
  • "connectedsubscriptions": [
    ]
}

Downloads the file contents

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

Responses

challenges

Operations related to challenges

Creates a new challenge

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
required
object (NewCahllengeUser)
startdate
required
string <date-time>
object (ChallengeType)

Responses

Request samples

Content type
application/json
{
  • "challenged": {
    },
  • "startdate": "2019-08-24T14:15:22Z",
  • "type": {
    }
}

Response samples

Content type
application/json
[
  • {
    }
]

Returns a paginated list of challenges

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

challengerid
integer

Userid of the user who issued the challenge

challengedid
integer

userid of the challenged user

typeid
integer
winnerid
integer

Userid of the user who won the challenge

status
required
string
Default: "pending"
Enum: "pending" "unanswered" "ongoing" "won" "lost" "all" "closed"
datespan_start
string

Start of date span formatted(YYYY-MM-DD) for filtering challenges that took place within this span

datespan_end
string

End of date span formatted(YYYY-MM-DD) for filtering challenges that took place within this span

sorting
required
string
Default: "active_desc"
Enum: "active_asc" "active_desc" "type_asc" "type_desc" "winner_asc" "winner_desc" "challenger_asc" "challenger_desc" "challenged_asc" "challenged_desc"
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a list of challengetypes

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a challenge object

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "achievements": {
    },
  • "category": "string",
  • "heartbeat": 0,
  • "level": 0,
  • "score": 0
}

Returns a challenge object

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "active": 0,
  • "challenged": {
    },
  • "challenger": {
    },
  • "created": { },
  • "daysremaining": 0,
  • "startdate": { },
  • "stopdate": { },
  • "type": {
    },
  • "winner": {
    }
}

Downloads the challenge contents

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "status": "string"
}

Downloads the challenge contents

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "status": "string"
}

leads

Operations related to leads

Creates a new leadactivity

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
id
integer
object (LeadActivityType)
comment
required
string
object (LeadUser)
followup
string <date-time>
done
required
integer
created
string <date-time>

this will be ignored on PUT/POST requests

updated
string <date-time>

this will be ignored on PUT/POST requests

object

this will be ignored on PUT/POST requests

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "type": {
    },
  • "comment": "string",
  • "user": {
    },
  • "followup": "2019-08-24T14:15:22Z",
  • "done": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "lead": {
    }
}

Returns a paginated list of leadactivities

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

done
integer

Filter Leads based on date of creation formatted(YYYY-MM-DD)

typeid
integer
leadid
integer
userid
integer
folowupdate
string
comment
string
sorting
required
string
Default: "done_asc"
Enum: "followupdate_asc" "followupdate_desc" "created_asc" "created_desc" "done_asc" "done_desc"
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates an leadactivity

Use this method to change root level properties of an leadactivity.

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
id
integer
object (LeadActivityType)
comment
required
string
object (LeadUser)
followup
string <date-time>
done
required
integer
created
string <date-time>

this will be ignored on PUT/POST requests

updated
string <date-time>

this will be ignored on PUT/POST requests

object

this will be ignored on PUT/POST requests

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "type": {
    },
  • "comment": "string",
  • "user": {
    },
  • "followup": "2019-08-24T14:15:22Z",
  • "done": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "lead": {
    }
}

Deletes an leadactivity

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Returns a article

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": {
    },
  • "comment": "string",
  • "user": {
    },
  • "followup": "2019-08-24T14:15:22Z",
  • "done": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "lead": {
    }
}

Creates a new lead

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
contacttitle
string
contactname
string
contactsurname
string
contactcompany
string
contactstreet
string
contactcity
string
contactzip
string
contactphone
string
contactcellphone
string
contactemail
string
contactvatno
string
value
number
created
string <date-time>

this will be ignored on PUT/POST requests

updated
string <date-time>

this will be ignored on PUT/POST requests

title
string
description
string
rating
integer
object (LeadUser)
object (Source)
object (Status)
Array of objects (IdObject)

Responses

Request samples

Content type
application/json
{
  • "contacttitle": "string",
  • "contactname": "string",
  • "contactsurname": "string",
  • "contactcompany": "string",
  • "contactstreet": "string",
  • "contactcity": "string",
  • "contactzip": "string",
  • "contactphone": "string",
  • "contactcellphone": "string",
  • "contactemail": "string",
  • "contactvatno": "string",
  • "value": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "title": "string",
  • "description": "string",
  • "rating": 0,
  • "user": {
    },
  • "source": {
    },
  • "status": {
    },
  • "tags": [
    ]
}

Returns a paginated list of leads

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

dynamicfield_id
Array of integers

Query by dynamicfield value. Each dynamicfield_id must be paired with a dynamicfield_val parameter in order to filter

dynamicfield_val
Array of strings

Query by dynamicfield value. Each dynamicfield_val must be paired with a dynamicfield_id parameter in order to filter

created
string

Filter Leads based on date of creation formatted(YYYY-MM-DD)

status
integer
source
integer
rating
integer
fulltext
string
userid
integer
userids
string
sorting
required
string
Default: "age_desc"
Enum: "age_asc" "age_desc" "statusid_asc" "statusid_desc" "userid_asc" "userid_desc" "sourceid_asc" "sourceid_desc" "value_asc" "value_desc"
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates an lead

Use this method to change root level properties of an lead.

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
contacttitle
string
contactname
string
contactsurname
string
contactcompany
string
contactstreet
string
contactcity
string
contactzip
string
contactphone
string
contactcellphone
string
contactemail
string
contactvatno
string
value
number
created
string <date-time>

this will be ignored on PUT/POST requests

updated
string <date-time>

this will be ignored on PUT/POST requests

title
string
description
string
rating
integer
object (LeadUser)
object (Source)
object (Status)
Array of objects (IdObject)

Responses

Request samples

Content type
application/json
{
  • "contacttitle": "string",
  • "contactname": "string",
  • "contactsurname": "string",
  • "contactcompany": "string",
  • "contactstreet": "string",
  • "contactcity": "string",
  • "contactzip": "string",
  • "contactphone": "string",
  • "contactcellphone": "string",
  • "contactemail": "string",
  • "contactvatno": "string",
  • "value": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "title": "string",
  • "description": "string",
  • "rating": 0,
  • "user": {
    },
  • "source": {
    },
  • "status": {
    },
  • "tags": [
    ]
}

Deletes an lead

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Returns a lead

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "contacttitle": "string",
  • "contactname": "string",
  • "contactsurname": "string",
  • "contactcompany": "string",
  • "contactstreet": "string",
  • "contactcity": "string",
  • "contactzip": "string",
  • "contactphone": "string",
  • "contactcellphone": "string",
  • "contactemail": "string",
  • "contactvatno": "string",
  • "value": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "title": "string",
  • "description": "string",
  • "rating": 0,
  • "user": {
    },
  • "source": {
    },
  • "status": {
    },
  • "tags": [
    ],
  • "activities": [
    ]
}

opportunities

Operations related to opportunities

Creates a new opportunity

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
accountid
required
integer
altaccountid
integer
contactid
required
integer
phone
string
title
required
string
description
required
string
userid
required
integer
result
string
value
number
altvalue
string
altvaluelabel
string
statusid
required
integer
estimatedenddate
required
string
lostreasonid
integer
typeid
required
integer
winreasonid
integer
enddate
string <date>

2020-01-25

stateid
integer
estimateid
integer
sourceid
string
closed
integer
Array of objects (IdObject)

Responses

Request samples

Content type
application/json
{
  • "accountid": 0,
  • "altaccountid": 0,
  • "contactid": 0,
  • "phone": "string",
  • "title": "string",
  • "description": "string",
  • "userid": 0,
  • "result": "string",
  • "value": 0,
  • "altvalue": "string",
  • "altvaluelabel": "string",
  • "statusid": 0,
  • "estimatedenddate": "string",
  • "lostreasonid": 0,
  • "typeid": 0,
  • "winreasonid": 0,
  • "enddate": "2019-08-24",
  • "stateid": 0,
  • "estimateid": 0,
  • "sourceid": "string",
  • "closed": 0,
  • "tags": [
    ]
}

Returns a paginated list of opportunities

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

dynamicfield_id
Array of integers

Query by dynamicfield value. Each dynamicfield_id must be paired with a dynamicfield_val parameter in order to filter

dynamicfield_val
Array of strings

Query by dynamicfield value. Each dynamicfield_val must be paired with a dynamicfield_id parameter in order to filter

userid
integer

id property of the Contact whith which the Contact takes place

userids
string

comma separated list of userids

accountid
integer
accounttypeids
string

Comma separated list of AccountType.id whose contacts are queried

accountuserids
string

Comma separated list of User.id of the user responsible for the Accounts whose contacts are queried

estimated_startdate
string

Start of date span formatted(YYYY-MM-DD) for filtering via estimatedenddate

estimated_enddate
string

End of date span formatted(YYYY-MM-DD) for filtering via estimatedenddate

actual_startdate
string

Start of date span formatted(YYYY-MM-DD) for filtering via actual end date

actual_enddate
string

End of date span formatted(YYYY-MM-DD) for filtering via actual end date

statusid
integer

id propterty of the OpportunityStatus object

statusids
string

comma separated list of statusids

estimateid
integer

id propterty of the OpportunityEstimate object

estimateids
string

comma separated list of estimateids

lostreasonid
integer

id propterty of the OpportunityLost object

winreasonid
integer

id propterty of the OpportunityWin object

contactid
integer

id property of the contact with which the appointment takes place

typeid
integer

id propterty of the OpportunityType object

closed
integer
Enum: 0 1

get open or closed opportunities

progressionstateid
integer

id propterty of the ProgressionState object

description
string

string to be matched against description

followedby
integer

id property of the user whose followed accounts are queried

fulltext
string

this property will be used in a search in title, description and result

sorting
required
string
Default: "date_asc"
Enum: "date_asc" "date_desc" "account_asc" "account_desc" "userid_asc" "userid_desc"
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a list of opportunityestimates

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Follows an opportunity

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

Request Body schema: application/json
required
key
required
integer
userid
required
integer

Responses

Request samples

Content type
application/json
{
  • "key": 0,
  • "userid": 0
}

Returns a list of opportunitylostreasons

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a list of progressionstates for opportunities

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a list of opportunitysources

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a list of opportunitystatuses

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a list of opportunitytypes

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Unfollows an opportunity

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

Request Body schema: application/json
required
key
required
integer
userid
required
integer

Responses

Request samples

Content type
application/json
{
  • "key": 0,
  • "userid": 0
}

Returns a list of opportunitywinreasons

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates an opportunity

Use this method to change root level properties of an opportunity.

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
accountid
required
integer
altaccountid
integer
contactid
required
integer
phone
string
title
required
string
description
required
string
userid
required
integer
result
string
value
number
altvalue
string
altvaluelabel
string
statusid
required
integer
estimatedenddate
required
string
lostreasonid
integer
typeid
required
integer
winreasonid
integer
enddate
string <date>

2020-01-25

stateid
integer
estimateid
integer
sourceid
string
closed
integer
Array of objects (IdObject)

Responses

Request samples

Content type
application/json
{
  • "accountid": 0,
  • "altaccountid": 0,
  • "contactid": 0,
  • "phone": "string",
  • "title": "string",
  • "description": "string",
  • "userid": 0,
  • "result": "string",
  • "value": 0,
  • "altvalue": "string",
  • "altvaluelabel": "string",
  • "statusid": 0,
  • "estimatedenddate": "string",
  • "lostreasonid": 0,
  • "typeid": 0,
  • "winreasonid": 0,
  • "enddate": "2019-08-24",
  • "stateid": 0,
  • "estimateid": 0,
  • "sourceid": "string",
  • "closed": 0,
  • "tags": [
    ]
}

Deletes an opportunity

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Returns an opportunity

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "account": {
    },
  • "accountid": 0,
  • "altaccount": {
    },
  • "altaccountid": 0,
  • "altvalue": 0,
  • "altvaluelabel": "string",
  • "changedate": { },
  • "changeuserid": 0,
  • "changeuser": {
    },
  • "closed": 0,
  • "contact": {
    },
  • "contactid": 0,
  • "description": "string",
  • "estimate": {
    },
  • "estimatedenddate": "2020-01-25",
  • "files": [
    ],
  • "followers": [
    ],
  • "lostreason": {
    },
  • "lostreasonid": 0,
  • "phone": "string",
  • "progressionstate": {
    },
  • "regdate": { },
  • "reguser": {
    },
  • "reguserid": 0,
  • "result": "string",
  • "source": {
    },
  • "sourceid": 0,
  • "state": {
    },
  • "stateid": 0,
  • "status": {
    },
  • "statusid": 0,
  • "title": "string",
  • "type": {
    },
  • "typeid": 0,
  • "user": {
    },
  • "userid": 0,
  • "value": 0,
  • "businessarea": {
    },
  • "winreason": {
    },
  • "winreasonid": 0,
  • "tags": [
    ]
}

orders

Operations related to orders

Creates a new order

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
placedate
required
string <_DateTime>

Date for when the order was placed, only the date part will be used

required
object (IdObject)
required
object (IdObject)
required
object (IdObject)
required
object (IdObject)
object (IdObject)
object (IdObject)
object (IdObject)
price
number
currencycode
string
currencyrate
number
statisticsprice
number
alternativevalue
number
alternateid
string
externalcomment
string
delivered
integer
deliverydate
string <_DateTime>

Date for when the order will be delivered, only the date part will be used

deliveryname
string
deliverystreet
string
deliveryzip
string
deliverycity
string
deliverycountry
string
invoicename
string
invoicestreet
string
invoicezip
string
invoicecity
string
invoicecountry
string
invoiceemail
string
invoicenumber
string
invoicedate
string
externalkey
string
internalcomment
string
marking
string
referencecode
string
extracode
string
object (IdObject)
object (IdObject)
object (IdObject)
Array of objects (IdObject)
Array of objects (OrderRow)

Responses

Request samples

Content type
application/json
{
  • "placedate": "2019-01-25T00:00:00.000Z",
  • "account": {
    },
  • "user": {
    },
  • "contact": {
    },
  • "status": {
    },
  • "deliveryterm": {
    },
  • "paymentterm": {
    },
  • "deliverytype": {
    },
  • "price": 0,
  • "currencycode": "string",
  • "currencyrate": 0,
  • "statisticsprice": 0,
  • "alternativevalue": 0,
  • "alternateid": "string",
  • "externalcomment": "string",
  • "delivered": 0,
  • "deliverydate": "2019-01-25T00:00:00.000Z",
  • "deliveryname": "string",
  • "deliverystreet": "string",
  • "deliveryzip": "string",
  • "deliverycity": "string",
  • "deliverycountry": "string",
  • "invoicename": "string",
  • "invoicestreet": "string",
  • "invoicezip": "string",
  • "invoicecity": "string",
  • "invoicecountry": "string",
  • "invoiceemail": "string",
  • "invoicenumber": "string",
  • "invoicedate": "string",
  • "externalkey": "string",
  • "internalcomment": "string",
  • "marking": "string",
  • "referencecode": "string",
  • "extracode": "string",
  • "user2": {
    },
  • "opportunity": {
    },
  • "type": {
    },
  • "tags": [
    ],
  • "rows": [
    ]
}

Returns a paginated list of orders

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

dynamicfield_id
Array of integers

Query by dynamicfield value. Each dynamicfield_id must be paired with a dynamicfield_val parameter in order to filter

dynamicfield_val
Array of strings

Query by dynamicfield value. Each dynamicfield_val must be paired with a dynamicfield_id parameter in order to filter

number
string
altnumber
string
externalkey
string
accountids
string
statusids
string
opportunityid
integer
contactid
integer
userids
string

comma separated list of userids

missionids
string

comma separated list of missionids

missionresult
integer
Enum: 0 1

only shows orders connected to missionid with result 1/0

datespan_start
string

Start of date span formatted(YYYY-MM-DD)

datespan_end
string

End of date span formatted(YYYY-MM-DD)

fulltext
string

this property will be used in a search in internal and external comments

typeids
string

comma separated list of typeids

accountresponsibleids
string

comma separated list of accountresponsibleids

accounttypeids
string

comma separated list of accounttypeids

sorting
required
string
Default: "placedate_desc"
Enum: "placedate_asc" "placedate_desc" "deliverydate_asc" "deliverydate_desc" "number_asc" "number_desc" "accountid_asc" "accountid_desc" "externalkey_asc" "externalkey_desc"
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates an order

Use this method to change root level properties of an order.

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
price
number
currencycode
string
currencyrate
number
statisticsprice
number
alternativevalue
number
buyprice
number
discounted
boolean
placedate
string <_DateTime>

Date for when the order was placed, only the date part will be used

alternateid
string
externalcomment
string
deliverydate
string <_DateTime>

Date for when the order will be delivered, only the date part will be used

deliveryname
string
deliverystreet
string
deliveryzip
string
deliverycity
string
deliverycountry
string
invoicename
string
invoicestreet
string
invoicezip
string
invoicecity
string
invoicecountry
string
invoiceemail
string
invoicenumber
string
invoicedate
string
externalkey
string
internalcomment
string
marking
string
referencecode
string
extracode
string
object (IdObject)
object (IdObject)
object (IdObject)
object (IdObject)
object (IdObject)
object (IdObject)
object (IdObject)
object (IdObject)
object (IdObject)
object (IdObject)
delivered
integer
Array of objects (IdObject)
Array of objects (OrderRow)

Responses

Request samples

Content type
application/json
{
  • "price": 0,
  • "currencycode": "string",
  • "currencyrate": 0,
  • "statisticsprice": 0,
  • "alternativevalue": 0,
  • "buyprice": 0,
  • "discounted": true,
  • "placedate": "2019-01-25T00:00:00.000Z",
  • "alternateid": "string",
  • "externalcomment": "string",
  • "deliverydate": "2019-01-25T00:00:00.000Z",
  • "deliveryname": "string",
  • "deliverystreet": "string",
  • "deliveryzip": "string",
  • "deliverycity": "string",
  • "deliverycountry": "string",
  • "invoicename": "string",
  • "invoicestreet": "string",
  • "invoicezip": "string",
  • "invoicecity": "string",
  • "invoicecountry": "string",
  • "invoiceemail": "string",
  • "invoicenumber": "string",
  • "invoicedate": "string",
  • "externalkey": "string",
  • "internalcomment": "string",
  • "marking": "string",
  • "referencecode": "string",
  • "extracode": "string",
  • "account": {
    },
  • "user": {
    },
  • "user2": {
    },
  • "opportunity": {
    },
  • "contact": {
    },
  • "status": {
    },
  • "deliveryterm": {
    },
  • "paymentterm": {
    },
  • "deliverytype": {
    },
  • "type": {
    },
  • "delivered": 0,
  • "tags": [
    ],
  • "rows": [
    ]
}

Deletes an order

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Returns an order

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "price": 0,
  • "currencycode": "string",
  • "currencyrate": 0,
  • "statisticsprice": 0,
  • "alternativevalue": 0,
  • "buyprice": 0,
  • "discounted": true,
  • "placedate": "2019-01-25T00:00:00.000Z",
  • "alternateid": "string",
  • "externalcomment": "string",
  • "deliverydate": "2019-01-25T00:00:00.000Z",
  • "deliveryname": "string",
  • "deliverystreet": "string",
  • "deliveryzip": "string",
  • "deliverycity": "string",
  • "deliverycountry": "string",
  • "invoicename": "string",
  • "invoicestreet": "string",
  • "invoicezip": "string",
  • "invoicecity": "string",
  • "invoicecountry": "string",
  • "invoiceemail": "string",
  • "invoicenumber": "string",
  • "invoicedate": "string",
  • "externalkey": "string",
  • "internalcomment": "string",
  • "marking": "string",
  • "referencecode": "string",
  • "extracode": "string",
  • "pricelist": {
    },
  • "tscreated": "2019-08-24T14:15:22Z",
  • "tsupdated": "2019-08-24T14:15:22Z",
  • "account": {
    },
  • "user": {
    },
  • "user2": {
    },
  • "opportunity": {
    },
  • "contact": {
    },
  • "status": {
    },
  • "deliveryterm": {
    },
  • "paymentterm": {
    },
  • "deliverytype": {
    },
  • "type": {
    },
  • "delivered": 0,
  • "tags": [
    ],
  • "rows": [
    ]
}

ordertypes

Operations related to ordertypes

Creates a new ordertype

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
id
integer
default
integer
name
required
string
sortorder
required
integer

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "default": 0,
  • "name": "string",
  • "sortorder": 0
}

Returns a paginated list of ordertypes

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

name
string
default
integer
sortorder
integer
sorting
required
string
Default: "sortorder_asc"
Enum: "name_asc" "name_desc" "sortorder_asc" "sortorder_desc"
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates an ordertype

Use this method to change root level properties of an ordertype.

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
id
integer
default
integer
name
required
string
sortorder
required
integer

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "default": 0,
  • "name": "string",
  • "sortorder": 0
}

Deletes an ordertype

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Returns a article

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "default": 0,
  • "name": "string",
  • "sortorder": 0
}

paymentterms

Operations related to paymentterms

Creates a new paymentterm

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
id
integer
name
required
string
default
integer
externalkey
required
string
days
required
integer

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "default": 0,
  • "externalkey": "string",
  • "days": 0
}

Returns a paginated list of paymentterms

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

name
string
default
integer
externalkey
string
days
integer
sorting
required
string
Default: "name_asc"
Enum: "name_asc" "name_desc" "days_asc" "days_desc"
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates an paymentterm

Use this method to change root level properties of an paymentterm.

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
id
integer
name
required
string
default
integer
externalkey
required
string
days
required
integer

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "default": 0,
  • "externalkey": "string",
  • "days": 0
}

Deletes an paymentterm

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Returns a article

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "default": 0,
  • "externalkey": "string",
  • "days": 0
}

pricelists

Operations related to pricelists

Creates a new pricelist

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
id
integer
name
string
active
required
boolean
start
required
string <date-time>
stop
required
string <date-time>
default
required
boolean
externalkey
string
strict
required
boolean
description
string
currencyid
integer
required
Array of objects (ArticlePrice)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "active": true,
  • "start": "2019-08-24T14:15:22Z",
  • "stop": "2019-08-24T14:15:22Z",
  • "default": true,
  • "externalkey": "string",
  • "strict": true,
  • "description": "string",
  • "currencyid": 0,
  • "prices": [
    ]
}

Returns a paginated list of pricelists

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

active
integer
start
string

Start of date span formatted(YYYY-MM-DD)

stop
string

End of date span formatted(YYYY-MM-DD)

default
integer
accountid
integer
accountnumber
string
externalkey
string
strict
integer
currencyid
integer
sorting
required
string
Default: "start_asc"
Enum: "name_asc" "name_desc" "start_asc" "start_desc" "active_asc" "active_desc"
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a new pricegroup

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
id
integer
name
required
string
required
object (ListedArticleUnit)
min
required
integer
max
required
integer

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "unit": {
    },
  • "min": 0,
  • "max": 0
}

Returns a paginated list of pricegroups

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

unitid
integer
quantity
integer
sorting
required
string
Default: "quantity_asc"
Enum: "unitid_asc" "unitid_desc" "quantity_asc" "quantity_desc"
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates an pricegroup

Use this method to change root level properties of an pricegroup.

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
id
integer
name
required
string
required
object (ListedArticleUnit)
min
required
integer
max
required
integer

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "unit": {
    },
  • "min": 0,
  • "max": 0
}

Deletes an pricegroup

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Returns a pricegroup

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "unit": {
    },
  • "min": 0,
  • "max": 0
}

Updates an pricelist

Use this method to change root level properties of an pricelist.

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
id
integer
name
string
active
required
boolean
start
required
string <date-time>
stop
required
string <date-time>
default
required
boolean
externalkey
string
strict
required
boolean
description
string
currencyid
integer
required
Array of objects (ArticlePrice)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "active": true,
  • "start": "2019-08-24T14:15:22Z",
  • "stop": "2019-08-24T14:15:22Z",
  • "default": true,
  • "externalkey": "string",
  • "strict": true,
  • "description": "string",
  • "currencyid": 0,
  • "prices": [
    ]
}

Deletes an pricelist

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Returns a pricelist

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "active": true,
  • "start": "2019-08-24T14:15:22Z",
  • "stop": "2019-08-24T14:15:22Z",
  • "default": true,
  • "externalkey": "string",
  • "strict": true,
  • "description": "string",
  • "currencyid": 0,
  • "prices": [
    ]
}

security

Operations related to security

Authenticates a set of credentials

Authorizations:
OAuth2X-Token
Request Body schema: multipart/form-data
Key
string
AppId
string

Responses

appserver

Cirrus Appserver

post_address

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
person_number
required
string

Responses

Request samples

Content type
application/json
{
  • "person_number": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "surname": "string",
  • "street": "string",
  • "city": "string",
  • "zip": "string"
}

Creates a new article Deprecated

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
abstract
required
string

userVisibleData

digest
string

userNonVisibleData

personalnumber
string

personalNumber of the person supposed to sign

requirement
object
nonce
string

Responses

Request samples

Content type
application/json
{
  • "abstract": "string",
  • "digest": "string",
  • "personalnumber": "string",
  • "requirement": { },
  • "nonce": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "message": "string",
  • "status": "string",
  • "orderref": "string",
  • "personalnumber": "string",
  • "autostarttoken": "string",
  • "hintcode": "string",
  • "completiondata": {
    }
}

Cancels a signing request Deprecated

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "message": "string",
  • "status": "string",
  • "orderref": "string",
  • "personalnumber": "string",
  • "autostarttoken": "string",
  • "hintcode": "string",
  • "completiondata": {
    }
}

Checks status of a signing request Deprecated

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "message": "string",
  • "status": "string",
  • "orderref": "string",
  • "personalnumber": "string",
  • "autostarttoken": "string",
  • "hintcode": "string",
  • "completiondata": {
    }
}

post_credit_check

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
person_number
required
string = 12 characters ^[0-9]{12}$

Responses

Request samples

Content type
application/json
{
  • "person_number": "stringstring"
}

Response samples

Content type
application/json
{
  • "person_number": "string",
  • "status": "string",
  • "correlationid": "string",
  • "checkdate": "2019-08-24T14:15:22Z",
  • "outcome": "string"
}

Returns a list of phone brands

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a list of budgetgroups

Authorizations:
OAuth2X-Token
query Parameters
brandid
integer

Filter models by brand

header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a list of budgetgroups

Authorizations:
OAuth2X-Token
query Parameters
modelid
integer

Filter options by model

header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "colours": {
    },
  • "sizes": {
    }
}

Returns a list of budgetgroups

Authorizations:
OAuth2X-Token
query Parameters
modelid
required
integer

Filter phones

colourid
integer

Filter phones

sizeid
integer

Filter by size

header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Performs an X-Token validation and extension

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

users

Operations related to users

Creates a new user

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
active
integer
cellphone
required
string
Array of objects (Department1)
email
string
id
integer
language
string
lastactive
object
name
required
string
phone
string
presentation
string
startpage
integer

DEPRECATED

surname
required
string
title
required
string
avatar_b64
string
photo_b64
string
Array of objects (UserSetting)
required
Array of objects (Role)
Array of objects (Tag)

Responses

Request samples

Content type
application/json
{
  • "active": 0,
  • "cellphone": "string",
  • "departments": [
    ],
  • "email": "string",
  • "id": 0,
  • "language": "string",
  • "lastactive": { },
  • "name": "string",
  • "phone": "string",
  • "presentation": "string",
  • "startpage": 0,
  • "surname": "string",
  • "title": "string",
  • "avatar_b64": "string",
  • "photo_b64": "string",
  • "settings": [
    ],
  • "roles": [
    ],
  • "tags": [
    ]
}

Returns a paginated list of users

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

active
integer
code
string

Filter users matching the external system code

fulltext
string

this property will be used in a search in name, surname, and email

sorting
required
string
Default: "name_asc"
Enum: "name_asc" "name_desc" "active_asc" "active_desc" "surname_asc" "surname_desc"
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get_budget_collection

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

userids
string

comma separated list of userids

year_from
integer
month_from
integer
year_to
integer
month_to
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a new department

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
id
required
integer
name
string
object (Department4)
object (ListedUser)
Array of objects (ListedUser)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "parent": {
    },
  • "manager": {
    },
  • "users": [
    ]
}

Returns a paginated list of departments

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

parentid
integer
managerid
integer
sorting
required
string
Default: "name_asc"
Enum: "name_asc" "name_desc"
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates a department

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
id
required
integer
name
string
object (Department4)
object (ListedUser)
Array of objects (ListedUser)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "parent": {
    },
  • "manager": {
    },
  • "users": [
    ]
}

Deletes a department

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Returns a department

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "parent": {
    },
  • "manager": {
    },
  • "users": [
    ]
}

Updates a user

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
active
integer
cellphone
string
customerid
integer
Array of objects (Department1)
email
string
object (UserEmailSetting)
id
integer
language
string
lastactive
object
name
string
phone
string
presentation
string
object (UserProperty)
Array of objects (UserSetting)
startpage
integer

DEPRECATED

surname
string
title
string
avatar_b64
string
photo_b64
string

Responses

Request samples

Content type
application/json
{
  • "active": 0,
  • "cellphone": "string",
  • "customerid": 0,
  • "departments": [
    ],
  • "email": "string",
  • "emailsettings": {
    },
  • "id": 0,
  • "language": "string",
  • "lastactive": { },
  • "name": "string",
  • "phone": "string",
  • "presentation": "string",
  • "properties": {
    },
  • "settings": [
    ],
  • "startpage": 0,
  • "surname": "string",
  • "title": "string",
  • "avatar_b64": "string",
  • "photo_b64": "string"
}

Returns a user

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "active": 0,
  • "cellphone": "string",
  • "customerid": 0,
  • "departments": [
    ],
  • "email": "string",
  • "emailsettings": {
    },
  • "id": 0,
  • "language": "string",
  • "lastactive": { },
  • "name": "string",
  • "phone": "string",
  • "presentation": "string",
  • "properties": {
    },
  • "settings": [
    ],
  • "startpage": 0,
  • "surname": "string",
  • "title": "string",
  • "avatar_b64": "string",
  • "photo_b64": "string"
}

Creates a new role

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
id
integer
name
string

Responses

Request samples

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

Returns a paginated list of roles

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

sorting
required
string
Default: "name_asc"
Enum: "name_asc" "name_desc" "id_asc" "id_desc"
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates a user

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
id
integer
name
string
surname
string
email
string
language
string
startpage
integer

DEPRECATED

active
integer
phone
string
cellphone
string
title
string
presentation
string
avatar_b64
string
photo_b64
string
Array of objects (Department1)
Array of objects (IdObject)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "surname": "string",
  • "email": "string",
  • "language": "string",
  • "startpage": 0,
  • "active": 0,
  • "phone": "string",
  • "cellphone": "string",
  • "title": "string",
  • "presentation": "string",
  • "avatar_b64": "string",
  • "photo_b64": "string",
  • "departments": [
    ],
  • "tags": [
    ]
}

Deletes a user

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Returns a user

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "active": 0,
  • "cellphone": "string",
  • "departments": [
    ],
  • "email": "string",
  • "id": 0,
  • "language": "string",
  • "lastactive": { },
  • "name": "string",
  • "phone": "string",
  • "presentation": "string",
  • "startpage": 0,
  • "surname": "string",
  • "title": "string",
  • "avatar_b64": "string",
  • "photo_b64": "string",
  • "settings": [
    ],
  • "roles": [
    ],
  • "tags": [
    ]
}

get_budget_collection

Authorizations:
OAuth2X-Token
path Parameters
userid
required
integer
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

userids
string

comma separated list of userids

year_from
integer
month_from
integer
year_to
integer
month_to
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

put_budget_item

Authorizations:
OAuth2X-Token
path Parameters
userid
required
integer
year
required
integer
month
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
budget
integer
pipeline
integer

Responses

Request samples

Content type
application/json
{
  • "budget": 0,
  • "pipeline": 0
}

delete_budget_item

Authorizations:
OAuth2X-Token
path Parameters
userid
required
integer
year
required
integer
month
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

get_budget_item

Authorizations:
OAuth2X-Token
path Parameters
userid
required
integer
year
required
integer
month
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "userid": 0,
  • "year": 0,
  • "month": 0,
  • "budget": 0,
  • "pipeline": 0,
  • "weeks": [
    ]
}

kpis

Operations related to kpi

Returns a paginated list of kpis

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

userid
required
integer
sorting
required
string
Default: "sort_asc"
Enum: "sort_asc" "sort_desc"
location
required
string
Default: "dashboard"
Enum: "dashboard" "all"
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

orderstatus

Operations related to orderstatus

Creates a new orderstatus

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
id
integer
default
integer
name
required
string
step
required
integer

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "default": 0,
  • "name": "string",
  • "step": 0
}

Returns a paginated list of orderstatus

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

name
string
default
integer
step
integer
sorting
required
string
Default: "name_asc"
Enum: "name_asc" "name_desc"
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates an orderstatus

Use this method to change root level properties of an orderstatus.

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
id
integer
default
integer
name
required
string
step
required
integer

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "default": 0,
  • "name": "string",
  • "step": 0
}

Deletes an orderstatus

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Returns a orderstatus

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "default": 0,
  • "name": "string",
  • "step": 0
}

missions

Operations related to missions

Creates a new mission

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
name
string
active
integer
description
string
startdate
string <date>

Date 'YYYY-MM-DD' for when the Mission starts

enddate
string <date>

Date 'YYYY-MM-DD' for when the Mission ends

script
string
pdf
string
video
string
terms
string
userid
integer
typeid
integer

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "active": 0,
  • "description": "string",
  • "startdate": "1985-11-17",
  • "enddate": "2010-03-15",
  • "script": "string",
  • "pdf": "string",
  • "video": "string",
  • "terms": "string",
  • "userid": 0,
  • "typeid": 0
}

Returns a paginated list of missions

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

active
integer
Default: 1
Enum: 0 1

get active or inactive missions

datespan_start
string <date-time>
datespan_end
string <date-time>
ownerid
integer

id property of the user owning the mission

ownerids
string

comma separated list of userids

typeid
integer

id property of the mission type

sorting
string
Default: "enddate_asc"
Enum: "enddate_asc" "enddate_desc" "startdate_asc" "startdate_desc" "name_asc" "name_desc" "number_asc" "number_desc"
accountids
string
activityids
string
articleids
string
userids
string
orderids
string
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates an mission

Use this method to change root level properties of an mission.

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
name
string
active
integer
description
string
startdate
string <date>

Date 'YYYY-MM-DD' for when the Mission starts

enddate
string <date>

Date 'YYYY-MM-DD' for when the Mission ends

script
string
pdf
string
video
string
terms
string
userid
integer
typeid
integer

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "active": 0,
  • "description": "string",
  • "startdate": "1985-11-17",
  • "enddate": "2010-03-15",
  • "script": "string",
  • "pdf": "string",
  • "video": "string",
  • "terms": "string",
  • "userid": 0,
  • "typeid": 0
}

Deletes an mission

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Returns an mission

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "startdate": "1985-11-17",
  • "enddate": "2010-03-15",
  • "active": 0,
  • "script": "string",
  • "pdf": "string",
  • "video": "string",
  • "terms": "string",
  • "userid": 0,
  • "typeid": 0
}

get_mission_connection_collection

Authorizations:
OAuth2X-Token
path Parameters
mission_id
required
integer
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

result
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get_mission_activity_connection_collection

Authorizations:
OAuth2X-Token
path Parameters
mission_id
required
integer
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

result
integer
typeids
string

comma separated list of activity type ids

userids
string

comma separated list of user ids

start
string <date-time>
end
string <date-time>
sorting
string
Default: "number_asc"
Enum: "start_asc" "start_desc" "end_asc" "end_desc" "number_asc" "number_desc"
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get_mission_connection_collection

Authorizations:
OAuth2X-Token
path Parameters
mission_id
required
integer
connection_type
required
string
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

result
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

put_mission_connection_item

Authorizations:
OAuth2X-Token
path Parameters
mission_id
required
integer
connection_type
required
string
other_id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

Request Body schema: application/json
required
type
string
connectid
integer
result
integer
tscreated
string <date-time>
tsupdated
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "connectid": 0,
  • "result": 0,
  • "tscreated": "2019-08-24T14:15:22Z",
  • "tsupdated": "2019-08-24T14:15:22Z"
}

delete_mission_connection_item

Authorizations:
OAuth2X-Token
path Parameters
mission_id
required
integer
connection_type
required
string
other_id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

Responses

get_mission_connection_item

Authorizations:
OAuth2X-Token
path Parameters
mission_id
required
integer
connection_type
required
string
other_id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "connectid": 0,
  • "result": 0,
  • "tscreated": "2019-08-24T14:15:22Z",
  • "tsupdated": "2019-08-24T14:15:22Z"
}

get_mission_progress_collection

Authorizations:
OAuth2X-Token
path Parameters
mission_id
required
integer
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

accountids
string

comma separated list of accountids

header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

contracts

Operations related to contracts

Creates a new contract

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
number
required
string
number2
string or null
description
string or null
object (IdObject)
start
required
string <date-time>
end
required
string <date-time>
installdate
string or null <date-time>
value
number
financed
integer
object (IdObject)
object (IdObject)
required
object (IdObject)
required
object (IdObject)
object (IdObject)
reminderdays
required
integer
externalkey
string or null

Responses

Request samples

Content type
application/json
{
  • "number": "string",
  • "number2": "nullable string",
  • "description": "nullable string",
  • "status": {
    },
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "installdate": "2019-08-24T14:15:22Z",
  • "value": 0,
  • "financed": 0,
  • "financeaccount": {
    },
  • "type": {
    },
  • "contact": {
    },
  • "responsible": {
    },
  • "responsibleservice": {
    },
  • "reminderdays": 0,
  • "externalkey": "nullable string"
}

Returns a paginated list of contracts

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

number
string
fulltext
string
contactids
string

comma separated list of contactids

financeaccountids
string

comma separated list of accountids

responsibleids
string

comma separated list of userids

responsibleserviceids
string

comma separated list of userids

typeids
string

comma separated list of objectcategoryids

statusids
string

comma separated list of objectcategoryids

objectids
string

comma separated list of objectids

externalkey
string
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get_contract_object_collection

Authorizations:
OAuth2X-Token
path Parameters
contract_id
required
integer
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

location
string
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

put_contract_object_item

Authorizations:
OAuth2X-Token
path Parameters
contract_id
required
integer
object_id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

Request Body schema: application/json
required
location
string or null

Responses

Request samples

Content type
application/json
{
  • "location": "nullable string"
}

delete_contract_object_item

Authorizations:
OAuth2X-Token
path Parameters
contract_id
required
integer
object_id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

Responses

get_contract_object_item

Authorizations:
OAuth2X-Token
path Parameters
contract_id
required
integer
object_id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

Responses

Response samples

Content type
application/json
{
  • "contractid": 0,
  • "objectid": 0,
  • "location": "nullable string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z"
}

put_contract_reminder_item

Authorizations:
OAuth2X-Token
path Parameters
contract_id
required
integer
activity_id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

Responses

delete_contract_reminder_item

Authorizations:
OAuth2X-Token
path Parameters
contract_id
required
integer
activity_id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

Responses

get_contract_reminder_item

Authorizations:
OAuth2X-Token
path Parameters
contract_id
required
integer
activity_id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

Responses

Response samples

Content type
application/json
{
  • "activityid": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z"
}

get_contract_reminder_collection

Authorizations:
OAuth2X-Token
path Parameters
contract_id
required
integer
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates a contract

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
number
string or null
number2
string or null
description
string or null
object (IdObject)
start
string <date-time>
end
string <date-time>
installdate
string or null <date-time>
value
number or null
financed
integer or null
IdObject (object) or (object or null)
object (IdObject)
object (IdObject)
IdObject (object) or (object or null)
IdObject (object) or (object or null)
reminderdays
integer or null
externalkey
string or null

Responses

Request samples

Content type
application/json
{
  • "number": "nullable string",
  • "number2": "nullable string",
  • "description": "nullable string",
  • "status": {
    },
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "installdate": "2019-08-24T14:15:22Z",
  • "value": "nullable number",
  • "financed": 0,
  • "financeaccount": {
    },
  • "type": {
    },
  • "contact": {
    },
  • "responsible": {
    },
  • "responsibleservice": {
    },
  • "reminderdays": 0,
  • "externalkey": "nullable string"
}

Deletes a contract

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Returns a contract

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "number": "nullable string",
  • "number2": "nullable string",
  • "description": "nullable string",
  • "status": {
    },
  • "start": "2019-08-24T14:15:22Z",
  • "end": "2019-08-24T14:15:22Z",
  • "installdate": "2019-08-24T14:15:22Z",
  • "value": "nullable number",
  • "financed": 0,
  • "financeaccount": {
    },
  • "type": {
    },
  • "contact": {
    },
  • "responsible": {
    },
  • "responsibleservice": {
    },
  • "reminderdays": 0,
  • "externalkey": "nullable string"
}

objects

Operations related to objects

Creates a new object

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
name
required
string
description
string or null
serialnumber
string or null
required
object (IdObject)
object (IdObject)
url
string or null
image1
string or null
image2
string or null
image3
string or null
externalkey
string or null
Array of objects (IdObject)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "nullable string",
  • "serialnumber": "nullable string",
  • "manufacturer": {
    },
  • "modelgroup": {
    },
  • "url": "nullable string",
  • "image1": "nullable string",
  • "image2": "nullable string",
  • "image3": "nullable string",
  • "externalkey": "nullable string",
  • "tags": [
    ]
}

Returns a paginated list of objects

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

dynamicfield_id
Array of integers

Query by dynamicfield value. Each dynamicfield_id must be paired with a dynamicfield_val parameter in order to filter

dynamicfield_val
Array of strings

Query by dynamicfield value. Each dynamicfield_val must be paired with a dynamicfield_id parameter in order to filter

serialnumber
string
fulltext
string
name
string
manufacturerids
string

comma separated list of accountids

modelgroupids
string

comma separated list of objectcategoryids

externalkey
string
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a new object category

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
type
required
string
name
required
string or null
sort
integer
default
integer

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "name": "nullable string",
  • "sort": 0,
  • "default": 0
}

Returns a paginated list of object categories

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

type
string
Enum: "modelgroup" "contracttype" "contractstatus"
name
string
default
integer
sorting
string
Enum: "order_asc" "order_desc" "name_asc" "name_desc"
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates a object category

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
type
string
name
string or null
sort
integer
default
integer

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "name": "nullable string",
  • "sort": 0,
  • "default": 0
}

Deletes a object category

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Returns a object category

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "nullable string",
  • "name": "nullable string",
  • "sort": 0,
  • "default": 0,
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z"
}

Updates a object

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
name
string or null
description
string or null
serialnumber
string or null
object (IdObject)
object (IdObject)
url
string or null
image1
string or null
image2
string or null
image3
string or null
externalkey
string or null
Array of objects (IdObject)

Responses

Request samples

Content type
application/json
{
  • "name": "nullable string",
  • "description": "nullable string",
  • "serialnumber": "nullable string",
  • "manufacturer": {
    },
  • "modelgroup": {
    },
  • "url": "nullable string",
  • "image1": "nullable string",
  • "image2": "nullable string",
  • "image3": "nullable string",
  • "externalkey": "nullable string",
  • "tags": [
    ]
}

Deletes a object

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Returns a object

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "nullable string",
  • "description": "nullable string",
  • "serialnumber": "nullable string",
  • "manufacturer": {
    },
  • "modelgroup": {
    },
  • "url": "nullable string",
  • "image1": "nullable string",
  • "image2": "nullable string",
  • "image3": "nullable string",
  • "externalkey": "nullable string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z",
  • "tags": [
    ]
}

get_object_contract_collection

Authorizations:
OAuth2X-Token
path Parameters
object_id
required
integer
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

location
string
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

put_object_contract_item

Authorizations:
OAuth2X-Token
path Parameters
object_id
required
integer
contract_id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

Request Body schema: application/json
required
location
string or null

Responses

Request samples

Content type
application/json
{
  • "location": "nullable string"
}

delete_object_contract_item

Authorizations:
OAuth2X-Token
path Parameters
object_id
required
integer
contract_id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

Responses

get_object_contract_item

Authorizations:
OAuth2X-Token
path Parameters
object_id
required
integer
contract_id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

Responses

Response samples

Content type
application/json
{
  • "contractid": 0,
  • "objectid": 0,
  • "location": "nullable string",
  • "created": "2019-08-24T14:15:22Z",
  • "updated": "2019-08-24T14:15:22Z"
}

get_object_relation_collection

Authorizations:
OAuth2X-Token
path Parameters
object_id
required
integer
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get_object_relation_collection

Authorizations:
OAuth2X-Token
path Parameters
object_id
required
integer
relation_type
required
string
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

put_object_relation_item

Authorizations:
OAuth2X-Token
path Parameters
object_id
required
integer
relation_type
required
string
other_id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

Responses

delete_object_relation_item

Authorizations:
OAuth2X-Token
path Parameters
object_id
required
integer
relation_type
required
string
other_id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

Responses

get_object_relation_item

Authorizations:
OAuth2X-Token
path Parameters
object_id
required
integer
relation_type
required
string
other_id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "objectid": 0,
  • "otherid": 0
}

settings

Operations related to settings

Updates settings

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
currency
string or null
object (PortalSettings)
object (SalesSettings)
object (FieldsalesSettings)
object (ConsentSettings)

Responses

Request samples

Content type
application/json
{
  • "currency": "nullable string",
  • "portal": {
    },
  • "sales": {
    },
  • "fieldsales": {
    },
  • "consent": {
    }
}

Returns settings

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "currency": "nullable string",
  • "portal": {
    },
  • "sales": {
    },
  • "fieldsales": {
    },
  • "consent": {
    }
}

addons

Operations related to addons

Returns a paginated list of addons

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

internalname
string
sorting
string
Default: "sort_asc"
Enum: "sort_asc" "sort_desc" "title_asc" "title_desc" "internalname_asc" "internalname_desc" "number_asc" "number_desc"
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns a addon

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "url": "string",
  • "internalname": "string",
  • "sort": 0,
  • "enabled": true,
  • "parameters": [
    ]
}

tags

Operations related to tags

Creates a new Tag

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
name
required
string
type
required
string
Enum: "company" "contact" "opportunity" "project" "lead" "order" "quote" "article" "orderrow" "quoterow" "activity" "object" "user" "template"

Responses

Request samples

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

Returns a paginated list of tags

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

fulltext
string
type
string
Enum: "company" "contact" "opportunity" "project" "lead" "order" "quote" "article" "orderrow" "quoterow" "activity" "object" "user" "template"
sorting
string
Default: "number_asc"
Enum: "number_asc" "number_desc" "name_asc" "name_desc"
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates a tag

Use this method to change root level properties of a tag.

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
name
string

Responses

Request samples

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

Deletes a tag

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Returns a tag

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

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

bankid

Cirrus BankID integration

Initiates a signing request

This API offers no support for animated QR codes, which will be mandatory for all signatures by 2024-05-01. New implementations must use Cirrus API Gateway instead.

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
abstract
required
string

userVisibleData

digest
string

userNonVisibleData

personalnumber
string

personalNumber of the person supposed to sign

requirement
object
nonce
string

Responses

Request samples

Content type
application/json
{
  • "abstract": "string",
  • "digest": "string",
  • "personalnumber": "string",
  • "requirement": { },
  • "nonce": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "message": "string",
  • "status": "string",
  • "orderref": "string",
  • "personalnumber": "string",
  • "autostarttoken": "string",
  • "hintcode": "string",
  • "completiondata": {
    }
}

Connects a bankid signature to another entity

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
signature
required
integer
type
required
string
otherid
required
integer

Responses

Request samples

Content type
application/json
{
  • "signature": 0,
  • "type": "string",
  • "otherid": 0
}

Lists the relations of a bankid signature

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

type
string
Value: "order"
otherid
integer
signatureid
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates or cancels a signing request

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
nonce
string
status
string
hintcode
string
orderref
string
completiondata
string
errorcode
string

Responses

Request samples

Content type
application/json
{
  • "nonce": "string",
  • "status": "string",
  • "hintcode": "string",
  • "orderref": "string",
  • "completiondata": "string",
  • "errorcode": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "message": "string",
  • "status": "string",
  • "orderref": "string",
  • "personalnumber": "string",
  • "autostarttoken": "string",
  • "hintcode": "string",
  • "completiondata": {
    }
}

Checks status of a signing request

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "message": "string",
  • "status": "string",
  • "orderref": "string",
  • "personalnumber": "string",
  • "autostarttoken": "string",
  • "hintcode": "string",
  • "completiondata": {
    }
}

quotes

Operations related to quotes

Creates a new quote

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
placedate
required
string <date>

Date for when the quote was placed

required
object (IdObject)
required
object (IdObject)
required
object (IdObject)
required
object (IdObject)
required
object (IdObject)
required
object (IdObject)
required
object (IdObject)
object (IdObject)
object (IdObject)
validtodate
string <date>

Last date the quote is valid (inclusive)

price
number
currencycode
string
currencyrate
number
statisticsprice
number
alternativevalue
number
alternateid
string
externalcomment
string
deliverydate
string <date>

Date for when the quote will be delivered

deliveryname
string
deliverystreet
string
deliveryzip
string
deliverycity
string
deliverycountry
string
externalkey
string
internalcomment
string
marking
string
referencecode
string
extracode
string
Array of objects (IdObject)
Array of objects (QuoteRow)

Responses

Request samples

Content type
application/json
{
  • "placedate": "2019-01-25",
  • "status": {
    },
  • "deliveryterm": {
    },
  • "paymentterm": {
    },
  • "deliverytype": {
    },
  • "account": {
    },
  • "contact": {
    },
  • "user": {
    },
  • "user2": {
    },
  • "opportunity": {
    },
  • "validtodate": "2019-01-25",
  • "price": 0,
  • "currencycode": "string",
  • "currencyrate": 0,
  • "statisticsprice": 0,
  • "alternativevalue": 0,
  • "alternateid": "string",
  • "externalcomment": "string",
  • "deliverydate": "2019-01-25",
  • "deliveryname": "string",
  • "deliverystreet": "string",
  • "deliveryzip": "string",
  • "deliverycity": "string",
  • "deliverycountry": "string",
  • "externalkey": "string",
  • "internalcomment": "string",
  • "marking": "string",
  • "referencecode": "string",
  • "extracode": "string",
  • "tags": [
    ],
  • "rows": [
    ]
}

Returns a paginated list of quotes

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

dynamicfield_id
Array of integers

Query by dynamicfield value. Each dynamicfield_id must be paired with a dynamicfield_val parameter in order to filter

dynamicfield_val
Array of strings

Query by dynamicfield value. Each dynamicfield_val must be paired with a dynamicfield_id parameter in order to filter

externalkey
string
altnumber
string
accountids
string

comma separated list of accountids

statusids
string

comma separated list of statusids

contactids
string

comma separated list of contactids

opportunityids
string

comma separated list of opportunityids

userids
string

comma separated list of userids

user2ids
string

comma separated list of userids

orderids
string

comma separated list of orderids

activityids
string

comma separated list of activityids

placedate_start
string

Start of date span formatted(YYYY-MM-DD)

placedate_end
string

End of date span formatted(YYYY-MM-DD)

validtodate_start
string

Start of date span formatted(YYYY-MM-DD)

validtodate_end
string

End of date span formatted(YYYY-MM-DD)

deliverydate_start
string

Start of date span formatted(YYYY-MM-DD)

deliverydate_end
string

End of date span formatted(YYYY-MM-DD)

fulltext
string

this property will be used in a search in internal and external comments

sorting
required
string
Default: "placedate_desc"
Enum: "placedate_asc" "placedate_desc" "validtodate_asc" "validtodate_desc" "deliverydate_asc" "deliverydate_desc" "number_asc" "number_desc" "externalkey_asc" "externalkey_desc"
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Connects a quote relation to another entity

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
quoteid
required
integer
type
required
string
otherid
required
integer
value
string

Responses

Request samples

Content type
application/json
{
  • "quoteid": 0,
  • "type": "string",
  • "otherid": 0,
  • "value": "string"
}

Lists the relations of a quote

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

type
string
Enum: "account" "opportunity" "contact" "user" "user2" "order"
otherid
integer
quoteid
integer
value
string
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Connects a quote relation to another entity

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
name
required
string
sortorder
integer
isdefault
integer
metatype
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "sortorder": 0,
  • "isdefault": 0,
  • "metatype": "string"
}

Lists the statuses a quote can have

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

metatype
string
Enum: "active" "expired" "denied" "order"
default
integer
sorting
required
string
Default: "sorting_asc"
Enum: "sorting_asc" "sorting_desc" "name_asc" "name_desc" "number_asc" "number_desc"
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates a quote status

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
name
string
sortorder
integer
isdefault
integer
metatype
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "sortorder": 0,
  • "isdefault": 0,
  • "metatype": "string"
}

Deletes a quote

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Returns a quote status

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "sortorder": 0,
  • "isdefault": 0,
  • "metatype": "string",
  • "tscreated": "2019-08-24T14:15:22Z",
  • "tsupdated": "2019-08-24T14:15:22Z"
}

Updates a quote

Use this method to change root level properties of a quote.

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
price
number
currencycode
string
currencyrate
number
statisticsprice
number
alternativevalue
number
buyprice
number
discounted
boolean
placedate
string <date>

Date for when the quote was placed

validtodate
string <date>

Last date the quote is valid (inclusive)

alternateid
string
externalcomment
string
deliverydate
string <date>

Date for when the quote will be delivered

deliveryname
string
deliverystreet
string
deliveryzip
string
deliverycity
string
deliverycountry
string
externalkey
string
internalcomment
string
marking
string
referencecode
string
extracode
string
object (IdObject)
object (IdObject)
object (IdObject)
object (IdObject)
object (IdObject)
object (IdObject)
object (IdObject)
object (IdObject)
object (IdObject)
Array of objects (IdObject)
Array of objects (QuoteRow)

Responses

Request samples

Content type
application/json
{
  • "price": 0,
  • "currencycode": "string",
  • "currencyrate": 0,
  • "statisticsprice": 0,
  • "alternativevalue": 0,
  • "buyprice": 0,
  • "discounted": true,
  • "placedate": "2019-01-25",
  • "validtodate": "2019-01-25",
  • "alternateid": "string",
  • "externalcomment": "string",
  • "deliverydate": "2019-01-25",
  • "deliveryname": "string",
  • "deliverystreet": "string",
  • "deliveryzip": "string",
  • "deliverycity": "string",
  • "deliverycountry": "string",
  • "externalkey": "string",
  • "internalcomment": "string",
  • "marking": "string",
  • "referencecode": "string",
  • "extracode": "string",
  • "user": {
    },
  • "user2": {
    },
  • "account": {
    },
  • "contact": {
    },
  • "opportunity": {
    },
  • "status": {
    },
  • "deliveryterm": {
    },
  • "paymentterm": {
    },
  • "deliverytype": {
    },
  • "tags": [
    ],
  • "rows": [
    ]
}

Deletes a quote

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Returns a quote

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "price": 0,
  • "currencycode": "string",
  • "currencyrate": 0,
  • "alternativevalue": 0,
  • "buyprice": 0,
  • "discounted": true,
  • "placedate": "2019-01-25",
  • "validtodate": "2019-01-25",
  • "alternateid": "string",
  • "externalcomment": "string",
  • "deliverydate": "2019-01-25",
  • "deliveryname": "string",
  • "deliverystreet": "string",
  • "deliveryzip": "string",
  • "deliverycity": "string",
  • "deliverycountry": "string",
  • "externalkey": "string",
  • "internalcomment": "string",
  • "marking": "string",
  • "referencecode": "string",
  • "extracode": "string",
  • "pricelist": {
    },
  • "tscreated": "2019-08-24T14:15:22Z",
  • "tsupdated": "2019-08-24T14:15:22Z",
  • "status": {
    },
  • "deliveryterm": {
    },
  • "paymentterm": {
    },
  • "deliverytype": {
    },
  • "user": {
    },
  • "user2": {
    },
  • "account": {
    },
  • "contact": {
    },
  • "opportunity": {
    },
  • "tags": [
    ],
  • "rows": [
    ]
}

emails

Operations related to emails

Returns a paginated list of emails Deprecated

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

accountid
integer
contactid
integer
date
string <date-time>
sorting
required
string
Default: "date_desc"
Enum: "date_asc" "date_desc"
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Deletes an email Deprecated

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Returns an email Deprecated

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "sender": "string",
  • "to": [
    ],
  • "cc": [
    ],
  • "subject": "string",
  • "date": "2019-01-25T00:00:00.000Z",
  • "body": "string",
  • "text": "string"
}

sortgroups

Operations related to sortgroups

Creates a new SortGroup

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
name
required
string
sort
required
integer
externalkey
string

Responses

Request samples

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

Returns a paginated list of tags

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

name
string
sort
integer
sorting
string
Default: "sort_asc"
Enum: "sort_asc" "sort_desc" "name_asc" "name_desc"
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates a Sortgroup

Use this method to change root level properties of a sorgroup.

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
name
string
sort
integer
externalkey
string

Responses

Request samples

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

Deletes a sortgroup

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Returns a sortgroup

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "sort": 0,
  • "externalkey": "string"
}

templates

Operations related to templates

Creates a new template Deprecated

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
name
required
string
resource
required
string
html
string
url
string
active
integer
Array of objects (IdObject)
Array of objects (IdObject)
Array of objects (IdObject)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "resource": "string",
  • "html": "string",
  • "url": "string",
  • "active": 0,
  • "languages": [
    ],
  • "categories": [
    ],
  • "tags": [
    ]
}

Returns a paginated list of templates Deprecated

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

name
string
active
integer
Enum: 0 1

get active or inactive templates

resource
string
Enum: "order" "quote"
languageids
string

Only list templates with languages in this comma separated list of ids

categoryids
string

Only list templates with categories in this comma separated list of ids

sorting
string
Default: "number_asc"
Enum: "name_asc" "name_desc" "number_asc" "number_desc"
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Creates a new template category Deprecated

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
name
required
string
sort
integer

Responses

Request samples

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

Returns a paginated list of template categories Deprecated

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

name
string
sorting
string
Default: "sort_asc"
Enum: "sort_asc" "sort_desc" "name_asc" "name_desc" "number_asc" "number_desc"
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

put_template_category_item Deprecated

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
name
string
sort
integer

Responses

Request samples

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

Returns a template category Deprecated

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

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

Creates a new template language Deprecated

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
name
required
string
sort
integer

Responses

Request samples

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

Returns a paginated list of template languages Deprecated

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

name
string
sorting
string
Default: "sort_asc"
Enum: "sort_asc" "sort_desc" "name_asc" "name_desc" "number_asc" "number_desc"
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

put_template_language_item Deprecated

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
name
string
sort
integer

Responses

Request samples

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

Returns a template language Deprecated

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

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

put_template_item Deprecated

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
name
string
resource
string
html
string
url
string
active
integer
Array of objects (IdObject)
Array of objects (IdObject)
Array of objects (IdObject)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "resource": "string",
  • "html": "string",
  • "url": "string",
  • "active": 0,
  • "languages": [
    ],
  • "categories": [
    ],
  • "tags": [
    ]
}

Returns a template Deprecated

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "resource": "string",
  • "html": "string",
  • "url": "string",
  • "active": 0,
  • "languages": [
    ],
  • "categories": [
    ],
  • "tags": [
    ]
}

subscriptions

Operations related to subscriptions

Creates a new subscription

TODO: do it properly

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
id
integer
active
integer
name
string
note
string
startdate
string
orderstartdate
string
typeid
integer
statusid
integer
intervalid
integer
periodid
integer
nextperiodid
integer
renewalperiodid
integer
renewalid
integer
advanceid
integer
parentid
integer
userid
integer
contactid
integer

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "active": 0,
  • "name": "string",
  • "note": "string",
  • "startdate": "string",
  • "orderstartdate": "string",
  • "typeid": 0,
  • "statusid": 0,
  • "intervalid": 0,
  • "periodid": 0,
  • "nextperiodid": 0,
  • "renewalperiodid": 0,
  • "renewalid": 0,
  • "advanceid": 0,
  • "parentid": 0,
  • "userid": 0,
  • "contactid": 0
}

Returns a paginated list of subscriptions

TODO.

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

name
string
sort
integer
sorting
string
Default: "sort_asc"
Enum: "sort_asc" "sort_desc" "name_asc" "name_desc"
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates a subscription TODO

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
name
string
sort
integer
externalkey
string

Responses

Request samples

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

Deletes a subscription

TODO.

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Returns a subscription

TODO.

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "sort": 0,
  • "externalkey": "string"
}

projects

Operations related to projects

Returns a paginated list of projects

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

dynamicfield_id
Array of integers

Query by dynamicfield value. Each dynamicfield_id must be paired with a dynamicfield_val parameter in order to filter

dynamicfield_val
Array of strings

Query by dynamicfield value. Each dynamicfield_val must be paired with a dynamicfield_id parameter in order to filter

accountid
integer
sorting
string
Default: "name_asc"
Enum: "name_asc" "name_desc" "number_asc" "number_desc"
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

leadstatus

Operations related to leadstatus

Creates a new leadstatus

Authorizations:
OAuth2X-Token
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
id
integer
name
required
string
sortorder
required
integer

Responses

Request samples

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

Returns a paginated list of leadstatus

Authorizations:
OAuth2X-Token
query Parameters
page
integer
Default: 1

Page number

per_page
integer
Default: 10

Results per page {error_msg}, max pagesize is 50

name
string
sortorder
integer
sorting
required
string
Default: "sortorder_asc"
Enum: "name_asc" "name_desc" "sortorder_asc" "sortorder_desc"
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Updates an leadstatus

Use this method to change root level properties of an leadstatus.

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Request Body schema: application/json
required
id
integer
name
required
string
sortorder
required
integer

Responses

Request samples

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

Deletes an leadstatus

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Returns a leadstatus

Authorizations:
OAuth2X-Token
path Parameters
id
required
integer
header Parameters
X-Token
string

X-Token can not be blank unless using a Bearer token from new auth

X-Fields
string

Mask which fields to include in the response '{id,name,description, etc}'

Responses

Response samples

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