List Profiles

GET https://{{axpAPIDomain}}/api/admin/user/v1/accounts/:accountId/profiles?pageNumber=2&pageSize=5

This API requires the Account Administrator role.

Lists all of the profiles for an account.

Request Params

Any value like 5, 10, 15, 20, 25, 30 is allowed.

Values that exceed the maximum will result in a 400 Bad Request being returned. | | filter | string | | Specifies details of a row filter.

The possible fields that can be filtered on are:

• profileName

The allowed format:

• Begins with the column name to be filtered, followed by a colon, (This will be used as a Contains operator.) then:
  • Either an exact string to match, or
  • A string expression including the * wildcard character.
    • :{PREFIX}* will be used to find out word start with.
    • :*{POSTFIX} will be used to find out word end with
    • : will be used to match exact word
• Begin with column name to be filtered, followed by a = operator. (this will be used to match exact string) | | orderBy | string | | Field name on which ordering needs to be performed. The default order is ascending.

The possible fields that can be ordered on are:

• profileName

Field Names are case-senstive (should be written as it is in description).

To specify descending order, a suffix " desc" should be added. For example, "profileName" for ascending or "profileName desc" for descending". |

HEADERS

RESPONSES

status: OK

{"pagination":{"pageNumber":2,"pageSize":10,"total":45},"profiles":[{"profileId":"W6D1JQ","profileName":"Advanced","description":"A profile with all the features","uxProfileId":"6f482dcd-54a9-445f-ba6d-8ca5ebd5261a","url":"/api/admin/user/v1/accounts/ASDJGE/profiles/W6D1JQ","roles":["Agent"],"memberOfGroups":["c8c2909d-75e9-484a-94c0-b7e8d29771fe"],"features":{"matching":{"attributes":["Language.English","Language.French"],"queues":[{"queueId":"620bbb28-7112-433a-af59-17ee0f15a247","proficiency":10},{"queueId":"07d2c0a3-f05c-47e7-a86e-51148d3d4fd4","proficiency":6}]},"chat":{"autoAnswer":false,"multiplicity":5,"afterContactWork":false},"messaging":{"autoAnswer":false,"multiplicity":5,"afterContactWork":false},"email":{"autoAnswer":false,"multiplicity":5,"afterContactWork":false},"voice":{"autoAnswer":false,"afterContactWork":false},"cmvoice":{"autoAssignExtension":false},"aci":{},"recorder":{},"outbound":{}},"links":{"prev":"/api/admin/user/v1/accounts/ASDJGE/profiles?pageNumber=1\u0026pageSize=10","next":"/api/admin/user/v1/accounts/ASDJGE/profiles?pageNumber=3\u0026pageSize=10"}}]}