Skip to content

List policies

Request

Returns a paginated list of policies for the specified organization.

Security
Bearer or PersonalAccessToken
Path
organizationIdstring, (uuid)required

Unique identifier of the organization

Query
Pageinteger, (int32)

The page number.

PageSizeinteger, (int32)

The number of items per page.

SearchTextstring

Optional free-text filter.

DocumentClassIdstring, (uuid)

Optional document class filter.

SortingKeystring(PolicySortingKey)

Optional sorting key.

Enum:"Name""Description""IsActive"
Ascendingboolean

Optional sort direction.

GET
/api/v1/organizations/{organizationId}/policies
curl -i -X GET \
  '/api/v1/organizations/{organizationId}/policies?Page=0&PageSize=0&SearchText=string&DocumentClassId=497f6eca-6276-4993-bfeb-53cbbbba6f08&SortingKey=Name&Ascending=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
policiesArray of objects(PolicySummary)required

The list of policies.

paginationobject(PaginationResponse)required

Pagination metadata.

Response
{ "policies": [ { … }, { … } ], "pagination": { "page": 1, "pageSize": 10, "totalCount": 2 } }