Skip to content

List playbooks

Request

Returns active playbooks by default. Pass include_all=true to include inactive playbooks.

Security
AuthorizationHeader
Query
include_allboolean

Include inactive playbooks

qstring

Search by playbook name

frominteger

Page number

sizeinteger

Records per page. Maximum allowed records per page is 200.

sort_bystring

Sort field

Enum:"playbook_name""risk""modified_date""is_active"
order_bystring

Sort order (asc or desc)

Enum:"asc""desc"
curl -i -X GET \
  'https://apidoc.authmind.com/_mock/v1/docs/v1/playbooks?include_all=true&q=string&from=0&size=0&sort_by=playbook_name&order_by=asc' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/json
errorstring
resultobject(models.OutListPlaybooksResultResponse)
successboolean
Response
{
  "error": "string",
  "result": {
    "data": [ … ],
    "total": 0
  },
  "success": true
}