List all roles.
Returns a paginated list of all roles.
Catalog visibility depends on authenticated organization/provider context.
Organization-scoped requests (Direct, OU, MSP customer org) return the organization catalog. MSP provider-only requests return either the provider management catalog or, when purpose=assignment, the provider assignment catalog.
Route availability is context-dependent: MSP provider-only requests require SP-10009-custom-role-mtp; all other contexts require na-1377-customroles-api.
Request
- Base URLhttps://console.jumpcloud.com/api/v2
- AuthAPI key in header x-api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
A filter to apply to the query.
Filter structure: <field>:<operator>:<value>.
field = Populate with a valid field from an endpoint response.
operator = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. Note: v1 operators differ from v2 operators.
value = Populate with the value you want to search for. Is case sensitive. Supports wild cards.
EX: GET /api/v2/groups?filter=name:eq:Test+Group
The number of records to return at once. Limited to 100.
The offset into the records to return.
The comma separated fields used to sort the collection. Default sort is ascending, prefix with - to sort descending.
When set to assignment in MSP provider context (authenticated MSP provider without organization context), returns the provider assignment catalog (system roles plus all provider-owned custom roles). Ignored for organization-scoped requests.
Headers
Organization identifier that can be obtained from console settings.
Multi-tenant Provider identifier that can be obtained from console settings.
Response
Successfully retrieved roles.
Changes
No recorded changes to this operation across all 1 revision of this API.