Search Client Governance

post

https://api.scalepad.com/controlmap/v1/clients/{client_id}/governance/search

Retrieves a paginated list of governance for a specific client.

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

client_id

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 – Governance code (e.g. GOV-1)
title – Governance title
status – Governance 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[] on each governance.data[] item.

Examples

"filter": {
  "code": "eq:GOV-1",
  "title": "eq:Governance for control of documented information",
  "status": "in:In Progress,Draft",
  "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, title

Sorting rules:

Ascending → code or +code
Descending → -code

Search request for client governance documents with filters, pagination, and sorting

filter

object

fields

string

Comma-separated response field list for sparse fieldsets.

page_size

int32

1 to 200

cursor

string

^[A-Za-z0-9+/=]*$

sort

string

^[+-]?[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*(,[+-]?[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*)*$

Sort field for the governance query.

Responses

200Governance retrieved successfully.

400Invalid request parameters.

401Unauthorized - Authentication required

404Not Found — the client could not be located.

500Server Internal Error — Unexpected failure.