List Procedures

get

https://example.com/cases/{id}/playbooks/{pid}/procedures

Return a list of procedures on a playbook on a case.

Path Params

string

required

Unique identifier for the case, either as an RFC 4122 formatted string, or as a number.

pid

uuid

required

Unique identifier for the playbook on the case, as an RFC 4122 formatted string.

Query Params

name

string

Filter results that have the specified name.

description

string

Filter results that have the specified description.

status

array of strings

Filter results that have the specified procedure status.

status

assignee

array of integers or null

Filter results that have a specific procedure assignee, by person numbers. Note that you can specify the literal value null to filter for unassigned procedures.

assignee

Headers

orderBy

string

enum

Defaults to ordering

Sorts the returned results by the specified field. ordering is the order in which the procedure appears in the playbook.

Allowed:

direction

string

enum

Defaults to asc

Sorts results in ascending or descending order.

Allowed:

Response

Language

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Returns the procedures of a specific playbook on a case.