API Reference

List Procedures (All Cases)

get
https://example.com/case-procedures

Return a filtered list of procedure information on all cases. Supports pagination.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Filter results that have the specified name.

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
date-time

Filter results that have a procedure due date before the specified date. Must be an RFC 3339 formatted string.

date-time

Filter results that have a procedure due date after the specified date. Must be an RFC 3339 formatted string.

caseNumber
array of integers

Filter results by case numbers.

caseNumber
string

Filter results that have a case name that contains the specified value.

date-time

Filter results that have a case due date before the specified date. Must be an RFC 3339 formatted string.

date-time

Filter results that have a case due date after the specified date. Must be an RFC 3339 formatted string.

priority
array of integers

Filter results that have a specific case priority.

priority
statusNumber
array of integers

Filter results that have a specific case status.

statusNumber
ownerNumber
array of integers

Filter results that have a specific case owner, by person numbers.

ownerNumber
integer

Filter results that have a specific case collaborator, by person number.

tagNumber
array of integers

Filter results that are tagged, by tag numbers.

tagNumber
Headers
integer
Defaults to 0

Number of results to skip when paging.

integer
Defaults to 25

Maximum number of results to be returned when paging.

string
enum
Defaults to dateUpdated

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

Allowed:
string
enum
Defaults to asc

Sorts results in ascending or descending order.

Allowed:
Response

Updated 23 days ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 23 days ago