ReDoc documentation

customers/{customerId}/companyRoles

customers/{customerId}/companyRoles

Get the company roles assigned to the given customer, filtered/paged per $searchCriteria. Returns one entry per company assignment in which the customer holds a role — not one per company assignment: a company the customer is assigned to but holds no role in contributes no entry at all. Returns an empty result when the customer is not a member of any company, holds no role in any of them, or when none of their companies/roles match $searchCriteria's filters. Supported filter fields: company_id, company_name (restrict which companies are considered), and resource_id, permission (restrict each matching role's permissions — a role left with no permissions after that narrowing is dropped from the result entirely). A single filter group (its filters are OR'd together) must not mix company fields with permission fields — throws otherwise. Supported condition types: eq and in on every field, plus like (SQL-style %/_ wildcards) on company_name. Sortable fields: id, company_id, role_name — applied to the result items themselves, after filtering and before paging (there's no sortable field within permissions).

Request
path Parameters
customerId
required
integer
query Parameters
searchCriteria[filterGroups][0][filters][0][field]
string

Field

searchCriteria[filterGroups][0][filters][0][value]
string

Value

searchCriteria[filterGroups][0][filters][0][conditionType]
string

Condition type

searchCriteria[sortOrders][0][field]
string

Sorting field.

searchCriteria[sortOrders][0][direction]
string

Sorting direction.

searchCriteria[pageSize]
integer

Page size.

searchCriteria[currentPage]
integer

Current page.

Responses
200

200 Success.

401

401 Unauthorized

500

Internal Server error

default

Unexpected error

get/V1/customers/{customerId}/companyRoles
Response samples
{
  • "items": [
    ],
  • "search_criteria": {
    },
  • "total_count": 0
}