Search Client Policies

Retrieves a paginated list of policies for a specific client.

Supports filtering, sorting, and cursor-based pagination via a JSON request body.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Unique identifier of the client

Body Params

Request payload containing filters, pagination, and sorting options.

Filtering

Filters must be passed inside the filter object.

Supported fields

  • code – Policy code (e.g. POL-3)
  • owner.name – Policy owner name
  • status – Policy status. Allowed values: Draft, In Progress, Ready For Approval, In Review, Approved
  • program_name – program names; unknown name → 400

Search results include programs[{id,name}] and objectives[] (when present) on each policy item.

Examples

"filter": {
  "code": "eq:POL-3",
  "owner.name": "in:Joel King,John",
  "status": "eq:Approved",
  "program_name": "eq:ISO-27001:2022"
}

Supported operators

  • eq — exact match
  • in — comma-separated list

Pagination

  • page_size default = 50, max = 200

Cursor Pagination

  • cursor must be Base64 encoded

Sorting

Allowed fields: code, created_date

Sorting rules:

  • Ascending → code or +code
  • Descending → -code

Search request for client policies with filters, pagination, and sorting

filter
object
string

Comma-separated response field list for sparse fieldsets.

int32
1 to 200
string
^[A-Za-z0-9+/=]*$
string
^[+-]?(code|created_date)(,[+-]?(code|created_date))*$

Sort field for the policy query.

Responses

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