---
title: StepChecklists
description: "StepChecklists: list, get, create, update and delete, plus batch operations."
canonical: https://developers.coevera.com/reference/rest/step-checklists/
section: rest
verification: schema
generatedFrom: spec 5e43371 (2026-10-16)
publisher: Coevera
---

# StepChecklists

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

Family: Pipelines, steps and processes. GraphQL: [stepChecklist](https://developers.coevera.com/reference/graphql/step-checklist.md). Base URL: `https://{region}.api.coevera.com/api/v100/rest/spaces/{space_id}`.

| 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 |
| DELETE | `/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 |

## List StepChecklists

`GET /entities/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.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `include-deleted` | query | boolean | Include soft-deleted records. Lists only; get-by-id refuses it. |
| `first` | query | integer | Page size. Default 30, maximum 100; a larger value is refused with HTTP 400, code 117. (default 30, 1 to 100) |
| `last` | query | integer | Return the last N records of the result; together with `first`, the last N of the first M. Maximum 100. (1 to 100) |
| `before` | query | string | Cursor from `page_info.start_cursor`, to page backwards. URL-encode it. |
| `after` | query | string | Cursor from `page_info.end_cursor` of the previous page. URL-encode it: cursors are base64, and a raw + becomes a space. |
| `expand` | query | string | Related records to return inline instead of their URIs, comma-separated; dots reach nested relations, as in `account_relations.account`. |
| `order-by` | query | string | Fields to sort by, comma-separated. A leading - sorts descending, as in `-modified`; dotted paths sort by related fields. |
| `filter` | query | 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` | query | 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` | query | 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, 401, 429, 500.

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

## Create StepChecklist

`POST /entities/StepChecklists`

Creates one record and answers 201 with it.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `validation-level` | query | 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`. Required: `step_id`, `visibility_condition`.

Responses: 201 (The created StepChecklist record.: `success`, `data`), 400, 401, 422, 429, 500.

```bash
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"
}'
```

## Get StepChecklist

`GET /entities/StepChecklists/{id}`

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

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `id` | path | string (uuid) | Required. Id of the StepChecklist record to retrieve. |
| `expand` | query | 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, 401, 404, 429, 500.

```bash
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"
```

## Update StepChecklist

`PATCH /entities/StepChecklists/{id}`

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

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `id` | path | string (uuid) | Required. Id of the StepChecklist record to update. |
| `validation-level` | query | 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`.

Responses: 200 (The changed StepChecklist record.: `success`, `data`), 400, 401, 404, 422, 429, 500.

```bash
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."
}'
```

## Delete StepChecklist

`DELETE /entities/StepChecklists/{id}`

Deletes one record and answers with its id.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `id` | path | string (uuid) | Required. Id of the StepChecklist record to delete. |

Responses: 200 (Deletion confirmation.: `success`, `data`), 400, 401, 404, 429, 500.

```bash
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"
```

## Create or update StepChecklists in a batch

`POST /entities/StepChecklists/batch-modify`

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.

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `validation-level` | query | 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` | query | 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. (default 0) |

Request body: A JSON array of records: an item with an `id` updates, an item without one creates. Schema `batchStepChecklistInput`. 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, 401, 422, 429, 500.

```bash
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."
  }
]'
```

## Delete StepChecklists in a batch

`POST /entities/StepChecklists/batch-delete`

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

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `rollback-method` | query | 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. (default 0) |

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, 401, 404, 422, 429, 500.

```bash
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"
]'
```

## Restore deleted StepChecklists

`POST /entities/StepChecklists/batch-restore`

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

| Parameter | In | Type | Description |
| --- | --- | --- | --- |
| `rollback-method` | query | 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. (default 0) |

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, 401, 404, 422, 429, 500.

```bash
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"
]'
```

## 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. Values: 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 … Values: 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. Values: 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. |
| `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. Values: 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: `GET /api/v100/rest/spaces/{space_id}/openapi.json` 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.

| 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). |

All error codes: https://developers.coevera.com/reference/errors.md; how to handle them: https://developers.coevera.com/concepts/errors.md