Tags 3 endpoints

GET /tags/{tag_id} Get tag details

operationId: getTagsTag_id

Parameters

Name	In	Required	Type	Description
tag_id	path	required	number	—

Responses

default

Successful

GET /tags/{tag_id}

PUT /tags/{tag_id} Update a tag

operationId: putTagsTag_id

Parameters

Name	In	Required	Type	Description
tag_id	path	required	number	—

Request Body

#/components/requestBodies/postTagsBody

Responses

200

Successful

PUT /tags/{tag_id}

GET /tags/{tag_id}/usage Get tag details on usage in workflows, saved filters & reports

operationId: getTagsTag_idUsage

Parameters

Name	In	Required	Type	Description
tag_id	path	required	number	—

Responses

default

Successful

GET /tags/{tag_id}/usage

Tasks 4 endpoints

GET /tasks List tasks

operationId: Tasks_listTasks

Parameters

Name	In	Required	Type	Description
id	query	optional	array	—
search	query	optional	string	—
assignees	query	optional	array	Defaults to the user
type	query	optional	array	—
account	query	optional	array	—
order_by	query	optional	array	Can be just ‘key’ e.g. ‘name’ or ‘key sortOrder’ e.g. ‘name desc’. Defaults to asc.
limit	query	optional	number	—
offset	query	optional	number	—
q	query	optional	string	—

Responses

200

Successful

GET /tasks

POST /tasks Create a task

operationId: Tasks_createTask

Request Body

application/json

schema TasksCreateTaskRequest

array of object

Property	Type	Required
account	number	optional
assignees	array	optional
description	string	required
reminder_date	string	optional

Responses

200

Successful

POST /tasks

DELETE /tasks/{id} Delete a task

operationId: Tasks_deleteTask

Responses

200

Successful

DELETE /tasks/{id}

PUT /tasks/{id} Update a task

operationId: Tasks_updateTask

Request Body

application/json

schema TasksUpdateTaskRequest

Property	Type	Required
account	number	optional
assignees	array	optional
completed	boolean	optional
description	string	optional
reminder_date	string	optional

Responses

200

Successful

PUT /tasks/{id}

Users 4 endpoints

GET /me Get current user's details

operationId: Users_getCurrentUserDetails

Responses

200

Successful

GET /me

GET /me/contacts List current user's contacts

operationId: Users_listContacts

Parameters

Name	In	Required	Type	Description
id	query	optional	array	—
name	query	optional	string	—
email	query	optional	string	—
phone_number	query	optional	string	—
domain	query	optional	string	—
modification_after	query	optional	string	—
modification_before	query	optional	string	—
creation_after	query	optional	string	—
creation_before	query	optional	string	—
account	query	optional	array	—
tag	query	optional	array	—
tag.name	query	optional	array	—
position.role	query	optional	array	—
address.country	query	optional	array	—
address.state_region	query	optional	array	—
address.city	query	optional	array	—
includeArchived	query	optional	boolean	—
search	query	optional	string	—
type	query	optional	string	—
limit	query	optional	number	—
offset	query	optional	number	—
custom	query	optional	string	—
order_by	query	optional	array	Can be just ‘key’ e.g. ‘name’ or ‘key sortOrder’ e.g. ‘name desc’. Defaults to asc.
q	query	optional	string	—

Responses

200

Successful

GET /me/contacts

GET /users List users

operationId: Users_list

Parameters

Name	In	Required	Type	Description
id	query	optional	array	—
name	query	optional	string	—
email	query	optional	string	—
search	query	optional	string	—
limit	query	optional	number	—
offset	query	optional	number	—
order_by	query	optional	array	Can be just ‘key’ e.g. ‘name’ or ‘key sortOrder’ e.g. ‘name desc’. Defaults to asc.
onlyEnabled	query	optional	boolean	—

Responses

default

Successful

GET /users

GET /users/{id} Get user details

operationId: Users_getUserDetails

Parameters

Name	In	Required	Type	Description
id	path	required	number	—

Responses

default

Successful

GET /users/{id}

Workflows 6 endpoints

GET /campaigns/mergefields Get a workflow's merge fields

Note that this route is currently still under /campaigns but might be moved in the future.

operationId: Workflows_getMergeFields

Responses

200

Successful

GET /campaigns/mergefields

GET /workflows List workflows

operationId: Workflows_list

Parameters

Name	In	Required	Type	Description
limit	query	optional	number	—
offset	query	optional	number	—
order_by	query	optional	array	Can be just ‘key’ e.g. ‘name’ or ‘key sortOrder’ e.g. ‘name desc’. Defaults to asc.
search	query	optional	string	—
q	query	optional	string	—

Responses

200

Successful

GET /workflows

POST /workflows Create a workflow

operationId: Workflows_createWorkflow

Request Body

#/components/requestBodies/postWorkflowsBody

Responses

200

Successful

POST /workflows

GET /workflows/{id} Get workflow details

operationId: Workflows_getDetails

Parameters

Name	In	Required	Type	Description
id	path	required	number	—

Responses

200

Successful

GET /workflows/{id}

PUT /workflows/{id} Update a workflow

operationId: Workflows_updateWorkflow

Parameters

Name	In	Required	Type	Description
id	path	required	number	—

Request Body

#/components/requestBodies/postWorkflowsBody

Responses

200

Successful

PUT /workflows/{id}

PUT /workflows/{id}/audience/{record_id} Re-enter or exit an entity from a workflow

operationId: putWorkflowsIdAudienceRecord_id

Parameters

Name	In	Required	Type	Description
id	path	required	number	—
record_id	path	required	number	This is the entity id. For email workflows this should be the contact id.

Request Body

application/json

schema PutWorkflowsIdAudienceRecordIdRequest

Property	Type	Required
exited	boolean	optional
met_goal	boolean	optional

Responses

200

Successful

PUT /workflows/{id}/audience/{record_id}