Reference Data

Lookup endpoints for the tenant-specific metadata required to drive review and scanner workflows.

List brands

get

Retrieve brands available to the authenticated tenant. These brand identifiers can be used when creating scanner jobs or filtering report results.

Authorizations

bearerApiKey

AuthorizationstringRequired

Supply the Protege external API key in the Authorization header using the format Bearer <api_key>.

Query parameters

idstring · uuidOptional

Filter by a specific brand identifier.

searchstringOptional

Case-insensitive search against brand names.

limitinteger · min: 1Optional

Maximum number of records to return.

offsetintegerOptional

Number of records to skip before returning results.

Default: 0

Responses

200

Brands returned

application/json

Paginated collection of brands.

400

Invalid query parameters

application/json

401

Missing or invalid API key

application/json

429

Rate limit exceeded

application/json

get/api/v1/brands

HTTPcURLJavaScriptPython

GET /api/v1/brands HTTP/1.1
Host: sandbox.tryprotege.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "brands": [
    {
      "id": "11111111-1111-1111-1111-111111111111",
      "name": "Acme"
    }
  ],
  "page": {
    "limit": 25,
    "offset": 0,
    "count": 1,
    "total": 1
  }
}

List policies

get

Return policy definitions that may be referenced by review findings or nested under policy groups and document evaluation types.

Authorizations

bearerApiKey

AuthorizationstringRequired

Supply the Protege external API key in the Authorization header using the format Bearer <api_key>.

Query parameters

idstring · uuidOptional

Filter by a specific policy identifier.

policyGroupIdstring · uuidOptional

Filter to policies that belong to a specific policy group.

searchstringOptional

Case-insensitive search against policy names.

limitinteger · min: 1Optional

Maximum number of records to return per page.

Default: 25

offsetintegerOptional

Number of records to skip before starting the page.

Default: 0

sortBystring · enumOptional

Field used to sort the result set.

Possible values:

sortOrderstring · enumOptional

Sort direction for the selected sort field.

Possible values:

Responses

200

Policies returned

application/json

Paginated collection of policies.

400

Invalid query parameters

application/json

401

Missing or invalid API key

application/json

429

Rate limit exceeded

application/json

get/api/v1/policies

HTTPcURLJavaScriptPython

GET /api/v1/policies HTTP/1.1
Host: sandbox.tryprotege.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "policies": [
    {
      "id": "11111111-1111-1111-1111-111111111111",
      "name": "No unqualified claims",
      "description": "Claims must be supported",
      "useCase": "marketing_review",
      "enabled": true,
      "riskLevel": "high",
      "policyGroup": {
        "id": "22222222-2222-2222-2222-222222222222",
        "name": "Claims"
      }
    }
  ],
  "page": {
    "limit": 25,
    "offset": 0,
    "count": 1,
    "total": 1
  }
}

List policy groups

get

Return policy groups available to the tenant. Use the expand=policies option when clients need the nested policy records in the same response.

Authorizations

bearerApiKey

AuthorizationstringRequired

Supply the Protege external API key in the Authorization header using the format Bearer <api_key>.

Query parameters

idstring · uuidOptional

searchstringOptional

limitinteger · min: 1Optional

Maximum number of records to return per page.

Default: 25

offsetintegerOptional

Number of records to skip before starting the page.

Default: 0

sortBystring · enumOptional

Field used to sort the result set.

Possible values:

sortOrderstring · enumOptional

Sort direction for the selected sort field.

Possible values:

expandstring · enumOptional

Expand related resources inline.

Possible values:

Responses

200

Policy groups returned

application/json

Paginated collection of policy groups.

400

Invalid query parameters

application/json

401

Missing or invalid API key

application/json

429

Rate limit exceeded

application/json

get/api/v1/policy-groups

HTTPcURLJavaScriptPython

GET /api/v1/policy-groups HTTP/1.1
Host: sandbox.tryprotege.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "policyGroups": [
    {
      "id": "22222222-2222-2222-2222-222222222222",
      "name": "Claims",
      "description": "Claims rules",
      "useCase": "marketing_review",
      "prePolicy": {
        "id": "33333333-3333-3333-3333-333333333333",
        "name": "Pre-check"
      }
    }
  ],
  "page": {
    "limit": 25,
    "offset": 0,
    "count": 1,
    "total": 1
  }
}

List document evaluation types

get

Return review configurations available to the tenant. These identifiers are required when creating document reviews or scanner jobs.

Authorizations

bearerApiKey

AuthorizationstringRequired

Supply the Protege external API key in the Authorization header using the format Bearer <api_key>.

Query parameters

idstring · uuidOptional

searchstringOptional

useCasestring · enumOptional

Filter evaluation types by business use case.

Possible values:

limitinteger · min: 1Optional

Maximum number of records to return per page.

Default: 25

offsetintegerOptional

Number of records to skip before starting the page.

Default: 0

sortBystring · enumOptional

Field used to sort the result set.

Possible values:

sortOrderstring · enumOptional

Sort direction for the selected sort field.

Possible values:

expandstring · enumOptional

Expand related policy groups inline.

Possible values:

Responses

200

Document evaluation types returned

application/json

Paginated list of document evaluation types available to the API key's tenant.

400

Invalid query parameters

application/json

401

Missing or invalid API key

application/json

429

Rate limit exceeded

application/json

get/api/v1/document-evaluation-types

HTTPcURLJavaScriptPython

GET /api/v1/document-evaluation-types HTTP/1.1
Host: sandbox.tryprotege.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "documentEvaluationTypes": [
    {
      "id": "22222222-2222-2222-2222-222222222222",
      "name": "Marketing Review",
      "description": "Checks marketing policies",
      "useCase": "marketing_review"
    }
  ],
  "page": {
    "limit": 25,
    "offset": 0,
    "count": 1,
    "total": 1
  }
}