Search Client Objectives

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

Supports filtering, sorting, and cursor-based pagination.

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

Unique identifier of the client

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

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

  • in_scope – Filters objectives by scope:

    • true: returns only in-scope objectives

    • false: returns only out-of-scope objectives

Examples

"filter": {
  "status": "in:Not Assessed,In Review",
  "in_scope": "eq:true",
}

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:

name, req_id

Sorting rules:

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

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

filter
object
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)(,[+-]?(id|name|req_id|sort_order))*$

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