Search Client Procedures

post

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

Retrieves a paginated list of procedures 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 – Procedure code (e.g. PRO-1)
title – Procedure title
status – Procedure status. Allowed values: Draft, In Progress, Ready For Approval, In Review, Approved
program_name – program names; unknown name → 400

Search results include top-level programs[{id,name}] (and objectives[] when present).

Examples

"filter": {
  "code": "eq:PRO-1",
  "title": "eq:Procedure 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 procedures 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

^[+-](code|title)(,[+-](code|title))*$

Sort field for the procedure query.

Responses

200Procedures retrieved successfully.

400Invalid request parameters.

401Unauthorized - Authentication required

404Not Found — the client could not be located.

500Server Internal Error — Unexpected failure.