API Reference

List Playbooks

get
https://example.com/lr-case-api/playbooks

Return a filtered list of playbooks. Supports pagination.

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

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

ownerNumber
array of integers

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

ownerNumber
retired
array of booleans
length ≤ 2
Defaults to false

Filter results by playbook retired status. Defaults to returning only non-retired playbooks.

retired
tagNumber
array of integers

Filter results that are tagged, by tag numbers.

tagNumber
entityNumber
array of integers

Filter results by entity numbers.

entityNumber
readPermissionLevel
array of strings

Filter results that have the specified read permission levels.

readPermissionLevel
writePermissionLevel
array of strings

Filter results that have the specified write permission levels.

writePermissionLevel
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 dateCreated

Sorts the returned results by the specified field.

Allowed:
string
enum
Defaults to asc

Sorts results in ascending or descending order.

Allowed:
date-time

Filter results that were updated after the specified date. Must be an RFC 3339 formatted string.

date-time

Filter results that were updated before the specified date. Must be an RFC 3339 formatted string.

date-time

Filter results that were created after the specified date. Must be an RFC 3339 formatted string.

date-time

Filter results that were created before the specified date. Must be an RFC 3339 formatted string.

Response

Updated 18 days ago

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

Updated 18 days ago