Skip to content

List playbooks

Request

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

Endpoint: GET /v1/playbooks. Authentication: requires AuthorizationHeader bearer token unless this operation's security is changed. Required AuthMind permission/scope: playbooks (grant this scope on the API token in Admin > API Tokens; a token without it receives 403 Forbidden). Documented parameters: include_all, q, from, size, sort_by, order_by. Pagination: use from and/or size as documented. Pagination convention for this endpoint: from is a one-based page number (default 1), size is the page length (default 50, subject to this endpoint's documented maximum). Sorting: use only documented sort fields and sort-order enum values. Response parsing: inspect success; on failure inspect error, errors, or message depending on the referenced schema.

Security
AuthorizationHeader
Query
include_allboolean

Include inactive playbooks

qstring

Search by playbook name

frominteger

Page number

Pagination parameter. One-based page number for this endpoint (default 1, minimum 1).

sizeinteger

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

Pagination page size / maximum records to return. Respect any endpoint-specific default or maximum stated here.

sort_bystring

Sort field

Controls sorting. Use only documented enum values when provided.

Allowed values: playbook_name, risk, modified_date, is_active.

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

Sort order (asc or desc)

Controls sorting. Use only documented enum values when provided.

Allowed values: asc, 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_JWT_HERE>'

Responses

Request completed successfully. See the referenced schema for the response envelope and result payload.

Bodyapplication/json
errorstring

Error message returned when the request fails. This is free-form, human-readable text intended for logging/display -- AuthMind does not define a stable, cross-endpoint error-code contract for it. Branch integration logic on the HTTP status code and the success boolean, not on the contents of this string.

resultobject(models.OutListPlaybooksResultResponse)

Primary response payload for this endpoint.

successboolean

Indicates whether the request was successful.

Response
{
  "error": "",
  "result": {
    "data": [ … ],
    "total": 2
  },
  "success": true
}