REST API Pipelines, steps and processesStepChecklists

StepChecklists

StepChecklists: list, get, create, update and delete, plus batch operations.

The summaries on this page are generated from the specification; written descriptions come with the next releases of the reference.

Method	Path	Operation
GET	`/entities/StepChecklists`	List StepChecklists
POST	`/entities/StepChecklists`	Create StepChecklist
GET	`/entities/StepChecklists/{id}`	Get StepChecklist
PATCH	`/entities/StepChecklists/{id}`	Update StepChecklist
DEL	`/entities/StepChecklists/{id}`	Delete StepChecklist
POST	`/entities/StepChecklists/batch-modify`	Create or update StepChecklists in a batch
POST	`/entities/StepChecklists/batch-delete`	Delete StepChecklists in a batch
POST	`/entities/StepChecklists/batch-restore`	Restore deleted StepChecklists

GET List StepChecklists

Returns the StepChecklists the API application can read, one page at a time. In the list envelope, total counts every match and page_info pages through them.

Query parameters

Name	Type	Description
`include-deleted`	boolean	Include soft-deleted records. Lists only; get-by-id refuses it.
`first`	integer	Page size. Default 30, maximum 100; a larger value is refused with HTTP 400, code 117.
`last`	integer	Return the last N records of the result; together with `first`, the last N of the first M. Maximum 100.
`before`	string	Cursor from `page_info.start_cursor`, to page backwards. URL-encode it.
`after`	string	Cursor from `page_info.end_cursor` of the previous page. URL-encode it: cursors are base64, and a raw + becomes a space.
`expand`	string	Related records to return inline instead of their URIs, comma-separated; dots reach nested relations, as in `account_relations.account`.
`order-by`	string	Fields to sort by, comma-separated. A leading - sorts descending, as in `-modified`; dotted paths sort by related fields.
`filter`	object	`filter[field]=value`. Separate several values with a raw comma (OR), as in `filter[name]=north,south`. Encode a comma that belongs to a value as %2C. URLSearchParams and Python requests encode every comma, so build the filter part of the query string yourself. Dotted paths filter on related records, as in `filter[owner.email]`. Encode a + in a value as %2B: query values are form-decoded, so a raw + becomes a space.
`filter-op`	object	`filter-op[field]=operator`, one per field: eq (the default), ieq, not-eq, not-ieq, contains, icontains, starts, istarts, ends, iends, gt, gte, lt, lte, between, null, not-null, empty and not-empty. null, not-null, empty and not-empty take no filter value; gt, gte, lt and lte take exactly one.
`load-only`	string	Fields to return, comma-separated (raw or encoded commas both work here); dots select nested fields, as in `owner.id`. All fields are returned without it. Lists only: get-by-id refuses it with HTTP 400, code 118.

Responses

200 Page of StepChecklist records.: success, total, page_info, data 400 Bad request 401 Not authenticated 429 Rate limited 500 Server error

curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/StepChecklists?first=10' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET"

fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/StepChecklists?first=10', {
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`)
  }
})

import os

import requests

response = requests.get(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/StepChecklists",
    params={
      "first": "10"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"])
)

POST Create StepChecklist

Creates one record and answers 201 with it.

Query parameters

Name	Type	Description
`validation-level`	integer	Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

Request body

The new record's fields. Relations are set by id. Schema createStepChecklistInput; the fields are in StepChecklist fields. Required: step_id, visibility_condition.

Responses

201 The created StepChecklist record.: success, data 400 Bad request 401 Not authenticated 422 Validation failed 429 Rate limited 500 Server error

curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/StepChecklists' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{
  "step_id": "d4000000-0000-4000-a000-000000000001",
  "visibility_condition": "Northwind visibility condition"
}'

fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/StepChecklists', {
  method: 'POST',
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    step_id: 'd4000000-0000-4000-a000-000000000001',
    visibility_condition: 'Northwind visibility condition'
  })
})

import os

import requests

response = requests.post(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/StepChecklists",
    headers={
      "Content-Type": "application/json"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"]),
    json={
      "step_id": "d4000000-0000-4000-a000-000000000001",
      "visibility_condition": "Northwind visibility condition"
    }
)

GET Get StepChecklist

Returns one record by id. expand returns related records inline instead of their URIs.

Path parameters

Name	Type	Description
`id`	string (uuid)	Id of the StepChecklist record to retrieve. Required

Query parameters

Name	Type	Description
`expand`	string	Related records to return inline instead of their URIs, comma-separated; dots reach nested relations. The only parameter this call accepts.

Responses

200 The StepChecklist record.: success, data 400 Bad request 401 Not authenticated 404 Not found 429 Rate limited 500 Server error

curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/StepChecklists/3a000000-0000-4000-a000-000000000001' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET"

fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/StepChecklists/3a000000-0000-4000-a000-000000000001', {
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`)
  }
})

import os

import requests

response = requests.get(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/StepChecklists/3a000000-0000-4000-a000-000000000001",
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"])
)

PATCH Update StepChecklist

Changes the fields you send and leaves the rest as they are; there is no PUT.

Path parameters

Name	Type	Description
`id`	string (uuid)	Id of the StepChecklist record to update. Required

Query parameters

Name	Type	Description
`validation-level`	integer	Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.

Request body

The fields to change. Schema updateStepChecklistInput; the fields are in StepChecklist fields.

Responses

200 The changed StepChecklist record.: success, data 400 Bad request 401 Not authenticated 404 Not found 422 Validation failed 429 Rate limited 500 Server error

curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/StepChecklists/3a000000-0000-4000-a000-000000000001' \
  --request PATCH \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "Updated through the API."
}'

fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/StepChecklists/3a000000-0000-4000-a000-000000000001', {
  method: 'PATCH',
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    description: 'Updated through the API.'
  })
})

import os

import requests

response = requests.patch(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/StepChecklists/3a000000-0000-4000-a000-000000000001",
    headers={
      "Content-Type": "application/json"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"]),
    json={
      "description": "Updated through the API."
    }
)

DEL Delete StepChecklist

Deletes one record and answers with its id.

Path parameters

Name	Type	Description
`id`	string (uuid)	Id of the StepChecklist record to delete. Required

Responses

200 Deletion confirmation.: success, data 400 Bad request 401 Not authenticated 404 Not found 429 Rate limited 500 Server error

curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/StepChecklists/3a000000-0000-4000-a000-000000000001' \
  --request DELETE \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET"

fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/StepChecklists/3a000000-0000-4000-a000-000000000001', {
  method: 'DELETE',
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`)
  }
})

import os

import requests

response = requests.delete(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/StepChecklists/3a000000-0000-4000-a000-000000000001",
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"])
)

POST Create or update StepChecklists in a batch

An item with an id updates that record; an item without one creates a record. By default one invalid item fails the whole call with HTTP 422 and nothing is written; with rollback-method=1 the response has an id or an error for each item, in input order.

Query parameters

Name	Type	Description
`validation-level`	integer	Bit mask that relaxes validation on this write. 0 (the default) validates everything. Bits: 2 skip unchanged fields, 4 skip admin-defined validations, 8 allow read-only fields, 16 skip relation checks, 32 skip value checks, 64 skip invalid recalculations, 128 skip step-checklist gates, 256 add conditional field requirements, 512 skip uniqueness checks. Add bits together (20 = 4 + 16); member names and comma lists such as 4,16 work too. A value with an internal-only bit is refused with HTTP 400, code 117.
`rollback-method`	integer	0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item.

Request body

A JSON array of records: an item with an id updates, an item without one creates. Schema batchStepChecklistInput; the fields are in StepChecklist fields. Required: step_id, visibility_condition.

Responses

200 Result per item, in request order: the id of the created or updated record, or the error.: success, data 400 Bad request 401 Not authenticated 422 Validation failed 429 Rate limited 500 Server error

curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/StepChecklists/batch-modify' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "step_id": "d4000000-0000-4000-a000-000000000001",
    "visibility_condition": "Northwind visibility condition"
  },
  {
    "id": "3a000000-0000-4000-a000-000000000001",
    "description": "Updated through the API."
  }
]'

fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/StepChecklists/batch-modify', {
  method: 'POST',
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
    'Content-Type': 'application/json'
  },
  body: JSON.stringify([
    {
      step_id: 'd4000000-0000-4000-a000-000000000001',
      visibility_condition: 'Northwind visibility condition'
    },
    {
      id: '3a000000-0000-4000-a000-000000000001',
      description: 'Updated through the API.'
    }
  ])
})

import os

import requests

response = requests.post(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/StepChecklists/batch-modify",
    headers={
      "Content-Type": "application/json"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"]),
    json=[
      {
        "step_id": "d4000000-0000-4000-a000-000000000001",
        "visibility_condition": "Northwind visibility condition"
      },
      {
        "id": "3a000000-0000-4000-a000-000000000001",
        "description": "Updated through the API."
      }
    ]
)

POST Delete StepChecklists in a batch

Deletes the records whose ids are in the body, a JSON array. By default an unknown id fails the whole call with HTTP 404.

Query parameters

Name	Type	Description
`rollback-method`	integer	0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item.

Request body

A JSON array of ids.

Responses

200 Result per id, in request order: the id of the deleted record, or the error.: success, data 400 Bad request 401 Not authenticated 404 Not found 422 Validation failed 429 Rate limited 500 Server error

curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/StepChecklists/batch-delete' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '[
  "3a000000-0000-4000-a000-000000000001",
  "3a000000-0000-4000-a000-000000000002"
]'

fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/StepChecklists/batch-delete', {
  method: 'POST',
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(['3a000000-0000-4000-a000-000000000001', '3a000000-0000-4000-a000-000000000002'])
})

import os

import requests

response = requests.post(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/StepChecklists/batch-delete",
    headers={
      "Content-Type": "application/json"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"]),
    json=[
      "3a000000-0000-4000-a000-000000000001",
      "3a000000-0000-4000-a000-000000000002"
    ]
)

POST Restore deleted StepChecklists

Restores the deleted records whose ids are in the body, a JSON array.

Query parameters

Name	Type	Description
`rollback-method`	integer	0, the default: one failed item fails the whole batch (HTTP 422, or 404 for an unknown id) and nothing is written. 1: the valid items are written and the call answers 200 with success false and one result per item, an id or an error, in input order. Check every item.

Request body

A JSON array of ids.

Responses

200 Result per id, in request order: the id of the restored record, or the error.: success, data 400 Bad request 401 Not authenticated 404 Not found 422 Validation failed 429 Rate limited 500 Server error

curl 'https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/StepChecklists/batch-restore' \
  --request POST \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '[
  "3a000000-0000-4000-a000-000000000001",
  "3a000000-0000-4000-a000-000000000002"
]'

fetch('https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/StepChecklists/batch-restore', {
  method: 'POST',
  headers: {
    Authorization: "Basic " + btoa(`${process.env.COEVERA_API_KEY}:${process.env.COEVERA_API_SECRET}`),
    'Content-Type': 'application/json'
  },
  body: JSON.stringify(['3a000000-0000-4000-a000-000000000001', '3a000000-0000-4000-a000-000000000002'])
})

import os

import requests

response = requests.post(
    "https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}/entities/StepChecklists/batch-restore",
    headers={
      "Content-Type": "application/json"
    },
    auth=(os.environ["COEVERA_API_KEY"], os.environ["COEVERA_API_SECRET"]),
    json=[
      "3a000000-0000-4000-a000-000000000001",
      "3a000000-0000-4000-a000-000000000002"
    ]
)

StepChecklist fields

Field	Type	Notes
`id`	uuid	Read-only Unique identifier of entity.
`step_id`	uuid → Steps	Required on create Id of the pipeline or process step this checklist item belongs to.
`visibility_condition`	binary	Required on create Filter expression that controls when the checklist item is shown.
`cloud_object_template`	uri → CloudObjectTemplates	Document template the checklist item fills and attaches to the record.
`activity_type_id`	uuid	Id of the appointment or task type that satisfies the checklist item, or empty when the item is not activity-based.
`cloud_object_format`	integer	File format of the document generated from cloud_object_template when item_type is UseDocumentTemplate: the template's own format or PDF.0 Default · 1 Pdf
`cloud_object_template_id`	uuid → CloudObjectTemplates	Id of the document template the checklist item fills and attaches to the record.
`description`	string	Free-text description shown alongside the checklist item.
`email_sequence_id`	uuid → EmailSequences	Id of the email sequence the record must be enrolled in to complete the item.
`field_id`	uuid → Fields	Id of the related field.
`item_type`	integer	Kind of checklist item, which determines what completes it, such as checking it off, filling in field, logging an activity of activity_type_id or running …1 Default · 2 ActivityType · 3 FieldType · 4 CreateNote · 5 AttachDocument · 6 SendEmail · 7 UseDocumentTemplate · 8 EnrollToEmailSequence · 9 RunProcess · 10 MapSalesRole · 11 CreateInfluenceMap
`item_validation`	integer	Condition the item must meet before the record can move past the step; empty when the item is optional.1 Required · 2 RelatedActivityCompleted · 3 RelatedActivityLinked
`label`	string	Display label of the checklist item.
`label_use_lang`	boolean	When true, label is treated as a translation key and localized in the UI; otherwise the literal text is shown.
`process_id`	uuid → Processes	Id of the related process.

Show all 35 fields

Field	Type	Notes
`send_email_field_id`	uuid → Fields	Id of the recipient field.
`send_email_lookup_field_id`	uuid → Fields	Id of the Contact or Account lookup field whose primary record supplies the recipient; empty when the recipient comes from the Primary Contact or Primary …
`send_email_template_id`	uuid → EmailTemplates	Id of the email template the email is pre-filled with when the item is completed by sending an email.
`visibility_type`	integer	Whether the item is always shown on the record or only when the record matches visibility_condition.0 Always · 1 Condition
`revision`	integer	Revision when entity was lastly changed.
`sales_roles`	array of uri → StepChecklistSalesRoleRelations	Sales roles the checklist item is shown to.
`is_delete_protected`	boolean	Read-only True when the record is protected against deletion because it must always exist in the space.
`is_deleted`	boolean	Read-only Specifies if the entity is considered deleted.
`modified`	date-time	Read-only Last modification time.
`created`	date-time	Read-only Creation time.
`appointment_type`	uri → AppointmentTypes	Read-only Appointment type that satisfies this checklist item.
`task_type`	uri → TaskTypes	Read-only Task type that satisfies this checklist item.
`email_sequence`	uri → EmailSequences	Read-only Email sequence the item should enroll the record into.
`field`	uri → Fields	Read-only Field whose value satisfies this checklist item.
`process`	uri → Processes	Read-only Automatizer process that completes the item once it has run for the record.
`send_email_field`	uri → Fields	Read-only Field that supplies the recipient email address when the checklist item triggers sending an email.
`send_email_lookup_field`	uri → Fields	Read-only Contact or Account lookup field whose primary record supplies the recipient.
`send_email_template`	uri → EmailTemplates	Read-only Email template the email is pre-filled with when the item is completed by sending an email.
`step`	uri → Steps	Read-only Pipeline or process step this checklist item belongs to.
`sort_order`	integer	Read-only Position of the checklist item within its step; lower values appear first.

Custom fields appear in your space's live spec: fetch it with your credentials.

Errors

Every error body has success: false, http_status, code, name and message. Branch on code: the status alone does not tell a missing permission from a bad parameter. All codes: error codes; how to handle them: Errors.

HTTP	When
400	Bad request: a bad or unknown parameter (codes 117, 118), a missing permission (code 50), conflicting data (code 2002) or any other API error. The REST API answers 400 where others answer 403 or 409; check `code`.
401	Not authenticated: missing or wrong credentials, a credential of another space, or an expired token (code 401, ERROR_UNAUTHORIZED).
404	No such record or entity (code 143 ERROR_NO_ENTITY, or 2006 ERROR_UNKNOWN_TYPE).
422	Validation failed (code 40000, with the failing fields) or a required parameter is missing (code 119). By default one failed item fails a whole batch and nothing is written.
429	Too many requests (code 182). Wait for the seconds in Retry-After, then retry.
500	Unexpected server error (code 1000, ERROR_UNKNOWN).