List Profiles

get

https://core.{customerId}.ec.avayacloud.com/api/config/v1/profiles

This API requires Account Administrator role.

Retrieves a paginated list of profiles with optional filtering and sorting capabilities.

Query Parameters:

pageNumber: Page number (default: 1)
pageSize: Number of profiles per page (5-100, default: 10)
orderBy: Sort field and direction (e.g., "name", "updatedAt desc")
filter: Filter profiles by field (e.g., "name:Support*", "licType=agent", "description:customer")
folderId: Filter by folder ID (omit for all folders, empty string for root folder, 26-char ID for specific folder)
includeSubfolders: Include profiles from subfolders recursively (default: false, only effective with specific folder ID)
updatedSince: Filter by profiles updated since this UTC date/time (ISO 8601 format)
updatedUntil: Filter by profiles updated until this UTC date/time (ISO 8601 format)

Folder Filtering Behavior:

No folderId parameter: Returns profiles from ALL folders in the account
folderId="" (empty string): Returns only root folder profiles (profiles not in any folder)
folderId="073d01090149abae69f6305afe": Returns profiles in that specific folder only
folderId="073d01090149abae69f6305afe" + includeSubfolders=true: Returns profiles from that folder AND all its subfolders recursively

Common Use Cases:

Get all profiles: /profiles (no folder parameters)
Get root folder profiles: /profiles?folderId=
Get specific folder profiles: /profiles?folderId=073d01090149abae69f6305afe
Get folder + all subfolders: /profiles?folderId=073d01090149abae69f6305afe&includeSubfolders=true

Supported Order Fields: name, description, licType, syncStatus, numUsers, createdBy, updatedBy, createdAt, updatedAt

Supported Filter Fields: name, description, licType, syncStatus, createdBy, updatedBy, createdAt, updatedAt

Filter Formats:

field=value - Exact match
field:value* - Prefix match (starts with)
field:*value - Suffix match (ends with)
field:value - Word match (contains)

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

pageNumber

int32

≥ 1

Defaults to 1

The page number of the records to retrieve.

pageSize

int32

5 to 100

Defaults to 10

Number of profiles per page

orderBy

string

Defaults to updatedAt desc

Field to sort by with optional desc suffix

filter

string

length ≤ 255

Specifies details of a row filter on one profile field.

The possible fields that can be filtered on are:

name
description
licType
syncStatus
createdBy
updatedBy
createdAt
updatedAt

The allowed format:

Begin with the column name to be filtered, followed by a = operator (used to match an exact string).
Or, begin with the column name to be filtered, followed by a colon, then:
- Either an exact string to match, or
- A string expression including the * wildcard character
  - :{PREFIX}* will be used to find values that start with the prefix.
  - :*{POSTFIX} will be used to find values that end with the postfix.
  - :{WORD} will be used to find values that contain the word.

Field names are case-sensitive.

folderId

^073[0-9a-f]{23}$

Filter profiles by folder location. This parameter controls which folder's profiles are returned:

If not provided (omitted): Returns profiles from ALL folders across the entire account (no folder filtering applied)
Empty string (""): Returns profiles in the root folder only (profiles not assigned to any folder)
26-character folder ID: Returns profiles in the specified folder only (by default, does NOT include subfolders)

Subfolder Behavior:

By default, subfolders are NOT searched - only profiles directly in the specified folder are returned
To include subfolders recursively, use the includeSubfolders=true parameter
When includeSubfolders=true, all profiles in the specified folder AND all its descendant folders are returned

Important Notes:

Root folder profiles omit the profileFolderId property from the response
To search multiple specific folders (non-recursively), make separate API calls

Unique identifier for a folder.

includeSubfolders

boolean

Defaults to false

Controls whether to include profiles from subfolders when filtering by a specific folder.

Behavior:

false (default): Returns only profiles directly in the specified folder
true: Returns profiles in the specified folder AND all its subfolders recursively

When this parameter takes effect:

Only when folderId is provided and is a valid 26-character folder ID
Ignored when folderId is not provided (all folders) or is empty string (root folder)
When folderId points to root folder (""), subfolders cannot be included

Performance considerations:

Recursive subfolder searches may take longer for deep folder hierarchies
Maximum recursion depth is limited to prevent performance issues

updatedSince

date-time

Filter profiles by their last update date. Returns only profiles that were updated on or after this date/time.

Format: ISO 8601 date/time with timezone offset (e.g., 2024-01-01T00:00:00Z or 2024-01-01T00:00:00-05:00)

Behavior:

Compares against the profile's updatedAt field (automatically maintained by the database)
Can be used alone or combined with updatedUntil for date range filtering
When used with updatedUntil, must be less than updatedUntil

Use Cases:

Get profiles modified after a specific date: ?updatedSince=2024-01-01T00:00:00Z
Get profiles from last 24 hours: ?updatedSince=2024-12-31T00:00:00Z
Combine with until for range: ?updatedSince=2024-01-01T00:00:00Z&updatedUntil=2024-12-31T23:59:59Z

updatedUntil

date-time

Filter profiles by their last update date. Returns only profiles that were updated on or before this date/time.

Format: ISO 8601 date/time with timezone offset (e.g., 2024-12-31T23:59:59Z or 2024-12-31T23:59:59-05:00)

Behavior:

Compares against the profile's updatedAt field (automatically maintained by the database)
Can be used alone or combined with updatedSince for date range filtering
When used with updatedSince, must be greater than updatedSince

Use Cases:

Get profiles modified before a specific date: ?updatedUntil=2024-12-31T23:59:59Z
Get profiles from a specific date range: ?updatedSince=2024-01-01T00:00:00Z&updatedUntil=2024-12-31T23:59:59Z
Exclude recent changes: ?updatedUntil=2024-11-30T23:59:59Z

crmConfigId

boolean

Defaults to true

Boolean toggle. When true (default), the response embeds the full CRM configuration object under crmConfigurations. When false, only the raw CRM configuration ID string is returned. This is a toggle, not a CRM config identifier.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses