Search Client Objectives

Retrieves a paginated list of objectives associated with a specific client.

Supports filtering, sorting, and cursor-based pagination. Document mappings are returned once per
managed document and include document_type (policy, procedure, or governance) so clients
can resolve the correct managed-document destination.

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

Unique identifier of the client

Accepts either the client UUID or the client's tenant_id.

int32
required

Unique identifier of the framework whose requirements are being retrieved.

Body Params

Request payload containing filters, pagination and sorting options.

Minimum required payload :
{}

Since this is a POST search endpoint, an empty JSON object is accepted.

Filtering

Filters must be passed inside the filter object.

Supported fields

  • search – Case-insensitive contains search across objective name and objective code. An operator prefix is optional; cont: is also accepted.

  • status – Allowed values: Not Assessed, Not Compliant, Partially Compliant, In Review, Compliant, Not Applicable

  • in_scope – Filters objectives by scope state:

    • true: returns only in-scope objectives

    • false: returns only out-of-scope objectives

  • scope_id – Filters by implementation scope. Supports eq and in.

  • level1_id – Filters by Level 1 identifier. Supports eq and in.

  • level2_id – Filters by Level 2 identifier. Supports eq and in.

Examples

"filter": {
  "search": "access",
  "status": "in:Not Assessed,In Review",
  "in_scope": "eq:true",
  "scope_id": "in:IG1,IG2",
  "level1_id": "eq:PROTECT"
}

Supported operators

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

Pagination

  • page_size default = 50
  • page_size max = 200

Cursor Pagination

  • cursor must be Base64 encoded.

Sorting

Allowed fields:

id, name, req_id, sort_order, status

Sorting rules:

  • Ascending → name or +name
  • Descending → -name

Query request for requirements with filters, fields, pagination, cursor, and sort

filter
object

Optional objective filters. Existing filters remain supported. Additional display filters are:
search (case-insensitive objective name or code), scope_id, level1_id, and level2_id.
Use eq for one hierarchy/scope value and in for multiple values.

string

Comma-separated response field list for sparse fieldsets.

int32
1 to 200
string
^[A-Za-z0-9+/=]*$
string
^[+-]?(id|name|req_id|sort_order|status)(,[+-]?(id|name|req_id|sort_order|status)){0,99}$

Sort field for the requirement 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