# Retrieve roles

Retrieves a list of user roles.

Endpoint: GET /roles
Version: latest
Security: SecretApiKey, JWT

## Query parameters:

  - `limit` (integer)
    Limits the number of collection items to be returned.

  - `offset` (integer)
    Specifies the starting point within the collection of items to be returned.

  - `filter` (string)
    Filters the collection items. This field requires
a special format. Use  for multiple allowed values.  Use  for multiple fields.

For more information, see
Using filter with collections.

  - `sort` (array)
    Sorts and orders the collection of items. To sort in descending
order, prefix with . Multiple fields can be sorted by separating each with .

  - `q` (string)
    Use this field to perform a partial search of text fields.

  - `expand` (string)
    Expands a request to include embedded objects within the 
property of the response. This field accepts a comma-separated list of objects.

For more information, see
Expand to include embedded objects.

## Response 200 fields (application/json):

  - `id` (string)
    ID of the role.
    Example: "role_0YVDN2J11HDMX9N8X7DCB4CMX2"

  - `name` (string, required)
    Name of the user role.

  - `description` (string,null)
    Description of the role.

  - `acl` (array, required)
    Access Control List (ACL) information.

  - `acl.scope` (object, required)
    Example: {"organizationId":["organizationId-id-1"]}

  - `acl.scope.organizationId` (array)
    Array of account IDs.
    Example: ["organizationId-id-1"]

  - `acl.scope.productId` (array)
    Array of product IDs.
    Example: ["prod_0YV7DES3WPC5J8JD8QTVNZBZNZ"]

  - `acl.scope.planId` (array)
    Array of plan IDs.
    Example: ["plan_0YV7DENSVGDBW9S71XZNNYYQ0X"]

  - `acl.scope.customFieldName` (array)
    Array of custom field names.

  - `acl.permissions` (array, required)
    Example: ["PostFile","StorefrontGetAccount","StorefrontGetWebsite","StorefrontGetKycDocumentCollection","StorefrontGetKycDocument","StorefrontPostKycDocument"]

  - `allowedIps` (array,null)
    List of IP addresses that are permitted access.
Private subnets are prohibited.
To remove restrictions, set this value to .
    Example: ["153.12.32.33","201.54.122.0/24","2001:0db8:abcd:0012:0000:0000:0000:ffff","2001:db8:abcd:12::0/64"]

  - `seniorIds` (array)
    List of role IDs where this role is used.
For example, a role called  may be used in the  and  roles.

  - `juniorIds` (array)
    List of role IDs that are included in this role.
For example, a role called  may include the  and  roles.

  - `usersCount` (integer)
    Number of users assigned to this role.

  - `createdTime` (string)
    Date and time which is set automatically when the resource is created.

  - `updatedTime` (string)
    Date and time which updates automatically when the resource is updated.

  - `_links` (array)
    Related links.

  - `_links.href` (string)
    Link URL.

  - `_links.rel` (string)
    Type of link.
    Enum: "self", "seniorRoles", "juniorRoles"

  - `_embedded` (object)
    Embedded objects that are requested by the  query parameter.

  - `_embedded.juniors` (array)

## Response 401 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.

## Response 403 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.