Roles

searchRoles

Search Roles

post/v1/permissions/roles:search

Request body

role_idsRoleId[]

List of role ids to filter by

org_idsOrganizationId[]

List of organization ids to filter by

slugsSlug[]

List of role slugs to filter by

querystring

Input to search across fields

limitnumber

The Number of roles to return

offsetnumber

The number of roles to skip before starting to collect the result set

Example request

{
  "role_ids": [
    "123:manager",
    "456:owner"
  ],
  "org_ids": [
    "123",
    "456"
  ],
  "slugs": [
    "manager",
    "owner"
  ],
  "query": "Administrator",
  "limit": 1,
  "offset": 1
}

Response

hitsnumber

Example response

{
  "results": [
    {
      "id": "123:owner",
      "name": "Owner",
      "slug": "owner",
      "expires_at": "2028-07-21T17:32:28Z",
      "organization_id": "123",
      "grants": [
        {
          "action": "entity-read",
          "resource": "entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947",
          "conditions": [
            {
              "attribute": "workflows.primary.task_name",
              "values": [
                "Qualification"
              ]
            }
          ]
        }
      ],
      "parent_role": "123:owner"
    }
  ]
}

Changes

Changed in 1 of the 2 revisions of this API.10

Aug 27, 2026b29ea9adf72b10See the full diff
- ○
  added the optional property results/items/oneOf[OrgRole]/allOf[BaseRole]/grants/items/conditions/items/allOf[subschema #2]/anyOf[EqualsCurrentUserCondition]/attributes to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property results/items/oneOf[PartnerRole]/allOf[BaseRole]/grants/items/conditions/items/allOf[subschema #2]/anyOf[EqualsCurrentUserCondition]/attributes to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property results/items/oneOf[PortalRole]/allOf[BaseRole]/grants/items/conditions/items/allOf[subschema #2]/anyOf[EqualsCurrentUserCondition]/attributes to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property results/items/oneOf[ShareRole]/allOf[BaseRole]/grants/items/conditions/items/allOf[subschema #2]/anyOf[EqualsCurrentUserCondition]/attributes to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property results/items/oneOf[UserRole]/allOf[BaseRole]/grants/items/conditions/items/allOf[subschema #2]/anyOf[EqualsCurrentUserCondition]/attributes to the response with the 200 status
  response-optional-property-added
- ○
  added NotEqualsCondition NotEqualsCurrentUserCondition to the results/items/oneOf[OrgRole]/allOf[BaseRole]/grants/items/conditions/items/allOf[subschema #2]/ response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  added NotEqualsCondition NotEqualsCurrentUserCondition to the results/items/oneOf[PartnerRole]/allOf[BaseRole]/grants/items/conditions/items/allOf[subschema #2]/ response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  added NotEqualsCondition NotEqualsCurrentUserCondition to the results/items/oneOf[PortalRole]/allOf[BaseRole]/grants/items/conditions/items/allOf[subschema #2]/ response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  added NotEqualsCondition NotEqualsCurrentUserCondition to the results/items/oneOf[ShareRole]/allOf[BaseRole]/grants/items/conditions/items/allOf[subschema #2]/ response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  added NotEqualsCondition NotEqualsCurrentUserCondition to the results/items/oneOf[UserRole]/allOf[BaseRole]/grants/items/conditions/items/allOf[subschema #2]/ response property anyOf list for the response status 200
  response-property-any-of-added

Full history