Skip to main content
GET
/
policies
curl --request GET \
  --url "https://api.roe-ai.com/v1/policies/?organization_id=YOUR_ORG_ID" \
  --header "Authorization: Bearer YOUR_API_KEY"
{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Compliance Review Policy",
      "description": "Policy for reviewing documents against compliance requirements",
      "organization_id": "org-12345678-1234-1234-1234-123456789012",
      "current_version_id": "456e7890-e89b-12d3-a456-426614174001",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-20T15:45:00Z"
    },
    {
      "id": "789e0123-e89b-12d3-a456-426614174002",
      "name": "Document Classification Policy",
      "description": "Policy for classifying incoming documents",
      "organization_id": "org-12345678-1234-1234-1234-123456789012",
      "current_version_id": "012e3456-e89b-12d3-a456-426614174003",
      "created_at": "2024-01-10T08:00:00Z",
      "updated_at": "2024-01-18T12:30:00Z"
    }
  ]
}
Retrieve a paginated list of all policies in your organization.

Query Parameters

ParameterTypeRequiredDescription
organization_iduuidYesUUID of the organization to list policies from
pageintegerNoPage number for pagination (default: 1)
page_sizeintegerNoNumber of results per page (default: 10)
searchstringNoSearch term to filter policies by name, description, or ID prefix (also matches version IDs)
orderingstringNoField to order results by. Options: name, -name, created_at, -created_at, updated_at, -updated_at (default: -updated_at)
curl --request GET \
  --url "https://api.roe-ai.com/v1/policies/?organization_id=YOUR_ORG_ID" \
  --header "Authorization: Bearer YOUR_API_KEY"
{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "Compliance Review Policy",
      "description": "Policy for reviewing documents against compliance requirements",
      "organization_id": "org-12345678-1234-1234-1234-123456789012",
      "current_version_id": "456e7890-e89b-12d3-a456-426614174001",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-20T15:45:00Z"
    },
    {
      "id": "789e0123-e89b-12d3-a456-426614174002",
      "name": "Document Classification Policy",
      "description": "Policy for classifying incoming documents",
      "organization_id": "org-12345678-1234-1234-1234-123456789012",
      "current_version_id": "012e3456-e89b-12d3-a456-426614174003",
      "created_at": "2024-01-10T08:00:00Z",
      "updated_at": "2024-01-18T12:30:00Z"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

A search term.

organization_id
string<uuid>
required

UUID of the organization for access control. Required.

Response

200 - application/json
count
integer
required
Example:

123

results
object[]
required
next
string<uri> | null
Example:

"http://api.example.org/accounts/?page=4"

previous
string<uri> | null
Example:

"http://api.example.org/accounts/?page=2"