---
updatedAt: 2026-07-20T22:29:29.000Z
---

# Get Profile Users with Override Status

**This API requires Account Administrator role.**

Retrieves a paginated list of users assigned to a specific profile, including their override statuses for profile fields.

This endpoint provides detailed information about which profile fields (permissions, queues, spaces, attributes, groups, themes, etc.) each user has overridden from the profile defaults.

**Override Fields Tracked:**
- permissions (nested structure)
- queues (access, performance, autoLogin, proficiency, logins, defaultOutboundQueue, outboundQueueId)
- spaces (task, email, phone, video, messaging)
- tags
- attributes
- groups
- appTheme
- consoleTheme
- timeZone
- interactionViewsType
- definedInteractionViews
- modifyInteractionViews
- commTypeChangeDefaultValue
- defaultOutboundCallerId
- locationId
- dialPlanProfileId
- deferEnabled
- enableWebHID
- enableErrorTones
- allowInternalCalls
- allowAgentEditAutoAnswer
- allowAgentEditWebHIDHeadsetControl
- rejectInteractions
- previewOutbound
- predictiveOutbound
- persistentMedia

**Filtering:**
- To filter on profile users that do or do not have overridden fields, use the `hasOverrides` query parameter

**Pagination:**
- If `pageNumber` and `pageSize` are provided, results are paginated (filtering is applied before pagination)


# OpenAPI definition

```json
{
  "openapi": "3.1.1",
  "info": {
    "title": "Profile Management",
    "description": "APIs for managing user profiles.\n\nOperations related to profile management: Create, Get, Update, Delete, List profiles.\n\nEach profile supports at most 500 assigned users. See the Users API for assignment limits;\nprofile updates are blocked when more than 500 users are assigned.\n",
    "version": "0.0.1",
    "contact": {
      "name": "Avaya API Team",
      "url": "https://developers.avayacloud.com/avaya-infinity/"
    },
    "license": {
      "name": "Avaya Software Development Kit (SDK) Software License Terms",
      "url": "https://support.avaya.com/css/P8/documents/101038288"
    }
  },
  "servers": [
    {
      "url": "https://core.{customerId}.ec.avayacloud.com/api/config/v1",
      "description": "Production",
      "variables": {
        "customerId": {
          "description": "Your organization identifier",
          "default": "your-org-id"
        }
      }
    }
  ],
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "tags": [
    {
      "name": "Profile Management",
      "description": "Operations related to profile management: Create, Get, Update, Delete, List profiles.\n"
    }
  ],
  "paths": {
    "/profiles/{profileId}/users": {
      "get": {
        "tags": [
          "Profile Management"
        ],
        "summary": "Get Profile Users with Override Status",
        "description": "**This API requires Account Administrator role.**\n\nRetrieves a paginated list of users assigned to a specific profile, including their override statuses for profile fields.\n\nThis endpoint provides detailed information about which profile fields (permissions, queues, spaces, attributes, groups, themes, etc.) each user has overridden from the profile defaults.\n\n**Override Fields Tracked:**\n- permissions (nested structure)\n- queues (access, performance, autoLogin, proficiency, logins, defaultOutboundQueue, outboundQueueId)\n- spaces (task, email, phone, video, messaging)\n- tags\n- attributes\n- groups\n- appTheme\n- consoleTheme\n- timeZone\n- interactionViewsType\n- definedInteractionViews\n- modifyInteractionViews\n- commTypeChangeDefaultValue\n- defaultOutboundCallerId\n- locationId\n- dialPlanProfileId\n- deferEnabled\n- enableWebHID\n- enableErrorTones\n- allowInternalCalls\n- allowAgentEditAutoAnswer\n- allowAgentEditWebHIDHeadsetControl\n- rejectInteractions\n- previewOutbound\n- predictiveOutbound\n- persistentMedia\n\n**Filtering:**\n- To filter on profile users that do or do not have overridden fields, use the `hasOverrides` query parameter\n\n**Pagination:**\n- If `pageNumber` and `pageSize` are provided, results are paginated (filtering is applied before pagination)\n",
        "operationId": "listProfileUsers",
        "parameters": [
          {
            "$ref": "#/components/parameters/profileId"
          },
          {
            "$ref": "#/components/parameters/pageNumber"
          },
          {
            "$ref": "#/components/parameters/pageSize"
          },
          {
            "name": "hasOverrides",
            "in": "query",
            "required": false,
            "description": "Filter users by override status. When `true`, only users who have at least one overridden field are returned.\nWhen `false`, only users with no overrides are returned. When omitted, all users are returned regardless of override status.\n",
            "schema": {
              "type": "boolean"
            },
            "example": true
          },
          {
            "name": "search",
            "in": "query",
            "required": false,
            "description": "Case-insensitive search string. Filters users whose first name, last name,\nor email address contains the given text.\n",
            "schema": {
              "type": "string",
              "maxLength": 100
            },
            "example": "john"
          }
        ],
        "responses": {
          "200": {
            "description": "Profile users retrieved successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ProfileUsersList"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/BadRequest"
          },
          "401": {
            "$ref": "#/components/responses/Unauthorized"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "404": {
            "$ref": "#/components/responses/NotFound"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          },
          "default": {
            "$ref": "#/components/responses/InternalServerError"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "description": "OAuth 2.0 Bearer Token with scoped permissions.\nRequired scopes documented per endpoint.\n"
      }
    },
    "responses": {
      "InternalServerError": {
        "description": "Internal Server Error",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Problem"
            },
            "example": {
              "type": "https://developers.avayacloud.com/avaya-infinity/docs/errors#internal-error",
              "title": "Internal Server Error",
              "status": 500,
              "detail": "An unexpected error occurred while processing your request",
              "requestId": "req_xyz789",
              "timestamp": "2025-12-08T10:30:05Z"
            }
          }
        }
      },
      "BadRequest": {
        "description": "Bad Request",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Problem"
            },
            "example": {
              "type": "https://developers.avayacloud.com/avaya-infinity/docs/errors#constraint-violation",
              "title": "Constraint Violation",
              "status": 400,
              "detail": "Request contains invalid or missing fields",
              "violations": [
                {
                  "field": "accountId",
                  "message": "must match \"^[a-zA-Z]{6}$\"",
                  "code": 20006
                }
              ]
            }
          }
        }
      },
      "Unauthorized": {
        "description": "Unauthorized",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Problem"
            },
            "example": {
              "type": "https://developers.avayacloud.com/avaya-infinity/docs/errors#unauthorized",
              "title": "Unauthorized",
              "status": 401,
              "detail": "Bearer token expired at 2025-12-08T10:15:00Z. Request a new token.",
              "requestId": "req_xyz789",
              "timestamp": "2025-12-08T10:30:05Z"
            }
          }
        }
      },
      "Forbidden": {
        "description": "Forbidden",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Problem"
            },
            "example": {
              "type": "https://developers.avayacloud.com/avaya-infinity/docs/errors#forbidden",
              "title": "Forbidden",
              "status": 403,
              "detail": "Missing required scope: 'workflows:execute'. Your token has: 'workflows:read'",
              "requestId": "req_xyz789",
              "timestamp": "2025-12-08T10:30:05Z"
            }
          }
        }
      },
      "NotFound": {
        "description": "Not Found",
        "content": {
          "application/problem+json": {
            "schema": {
              "$ref": "#/components/schemas/Problem"
            },
            "example": {
              "type": "https://developers.avayacloud.com/avaya-infinity/docs/errors#not-found",
              "title": "Not Found",
              "status": 404,
              "detail": "workflowId 'wf_123abc' does not exist",
              "requestId": "req_xyz789",
              "timestamp": "2025-12-08T10:30:05Z"
            }
          }
        }
      }
    },
    "parameters": {
      "profileId": {
        "name": "profileId",
        "in": "path",
        "description": "The unique identifier of a profile.",
        "required": true,
        "schema": {
          "$ref": "#/components/schemas/ProfileId"
        }
      },
      "pageNumber": {
        "name": "pageNumber",
        "in": "query",
        "description": "The page number of the records to retrieve.",
        "required": false,
        "schema": {
          "type": "integer",
          "format": "int32",
          "default": 1,
          "minimum": 1
        }
      },
      "pageSize": {
        "name": "pageSize",
        "in": "query",
        "description": "The max number of records to retrieve per page.",
        "required": false,
        "schema": {
          "type": "integer",
          "format": "int32",
          "default": 10,
          "minimum": 1,
          "maximum": 50
        }
      }
    },
    "schemas": {
      "ProfileUsersList": {
        "type": "object",
        "description": "List of users assigned to a profile with override status. Includes pagination metadata if pagination parameters were provided.",
        "required": [
          "users"
        ],
        "properties": {
          "pagination": {
            "$ref": "#/components/schemas/Pagination",
            "description": "Pagination metadata (only present when pageNumber and pageSize query parameters are provided)"
          },
          "links": {
            "$ref": "#/components/schemas/Links",
            "description": "Pagination navigation links (only present when pageNumber and pageSize query parameters are provided)"
          },
          "users": {
            "type": "array",
            "description": "Array of users assigned to the profile",
            "items": {
              "$ref": "#/components/schemas/ProfileUser"
            }
          }
        }
      },
      "ProfileUser": {
        "type": "object",
        "description": "User assigned to a profile with override status information",
        "required": [
          "userId",
          "email",
          "firstName",
          "lastName",
          "fullName",
          "hasOverrides",
          "overriddenFields"
        ],
        "properties": {
          "userId": {
            "$ref": "#/components/schemas/UserId",
            "description": "Unique identifier of the user"
          },
          "email": {
            "$ref": "#/components/schemas/Email"
          },
          "firstName": {
            "$ref": "#/components/schemas/FirstName"
          },
          "lastName": {
            "$ref": "#/components/schemas/LastName"
          },
          "fullName": {
            "$ref": "#/components/schemas/FullName"
          },
          "hasOverrides": {
            "type": "boolean",
            "description": "Whether the user has any overrides from the profile defaults",
            "example": true
          },
          "overriddenFields": {
            "type": "array",
            "description": "List of profile field paths that have been overridden by this user. Field paths use dot notation (e.g., 'permissions.app.agent.read', 'queues.access', 'appTheme')",
            "items": {
              "type": "string"
            },
            "example": [
              "permissions.app.agent.read",
              "queues.access",
              "appTheme"
            ],
            "readOnly": true
          },
          "folderId": {
            "allOf": [
              {
                "$ref": "#/components/schemas/FolderId"
              }
            ],
            "readOnly": true,
            "description": "Folder ID of the user's assigned profile."
          }
        }
      },
      "FolderId": {
        "description": "Unique identifier for a folder.",
        "type": "string",
        "pattern": "^073[0-9a-f]{23}$",
        "example": "073d010813b941cf7da111d147"
      },
      "Violation": {
        "type": "object",
        "properties": {
          "field": {
            "description": "The name of the field in the request that caused the violation.\n\nThis can be the name of a path parameter, query parameter, or a field within the request body.\n",
            "type": "string",
            "readOnly": true,
            "example": "jobName"
          },
          "message": {
            "description": "A human-readable explanation specific to this occurrence of the violation.\n",
            "type": "string",
            "readOnly": true,
            "example": "must match \"^[a-zA-Z]{6}$\""
          },
          "code": {
            "description": "The violation code generated by the server for this occurrence of the violation.\n\nUse this code when implementing any error handling logic instead of the message, as the message can change.\n",
            "type": "integer",
            "format": "int32",
            "readOnly": true,
            "example": 20006
          }
        },
        "required": [
          "field",
          "message",
          "code"
        ],
        "example": [
          {
            "field": "emailAddress",
            "message": "must not be null",
            "code": 20002
          }
        ]
      },
      "Problem": {
        "type": "object",
        "description": "<b>Problem Detail</b> is a way to carry machine-readable details of errors in an HTTP\nresponse to avoid the need to define new error response formats for HTTP APIs\n\n<a href=\"https://tools.ietf.org/html/rfc7807\">RFC 7807</a>\n",
        "properties": {
          "type": {
            "description": "An absolute URI that identifies the problem type.\n\nWhen dereferenced, it SHOULD provide human-readable documentation for the problem type (e.g., using HTML).\n",
            "type": "string",
            "format": "uri",
            "readOnly": true,
            "example": "https://developers.avayacloud.com/avaya-infinity/docs/errors#constraint-violation"
          },
          "title": {
            "description": "A short, summary of the problem type.\n\nWritten in English and readable for engineers (usually not suited for non technical stakeholders and not localized).\n",
            "type": "string",
            "readOnly": true,
            "example": "Service Unavailable"
          },
          "status": {
            "description": "The HTTP status code generated by the origin server for this occurrence of the problem.\n",
            "type": "integer",
            "format": "int32",
            "minimum": 300,
            "exclusiveMaximum": 600,
            "readOnly": true,
            "example": 503
          },
          "detail": {
            "description": "A human-readable explanation specific to this occurrence of the problem.\n",
            "type": "string",
            "readOnly": true,
            "example": "Connection to database timed out"
          },
          "instance": {
            "description": "An absolute URI that identifies the specific occurrence of the problem.\n\nIt may or may not yield further information if dereferenced.\n",
            "type": "string",
            "format": "uri",
            "readOnly": true
          },
          "violations": {
            "description": "A list of violations that occurred as a result of invalid data provided as part of a request.\n",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Violation"
            },
            "readOnly": true
          },
          "requestId": {
            "description": "A unique identifier for this request, useful when contacting support about a specific error occurrence.\n",
            "type": "string",
            "readOnly": true,
            "example": "req_xyz789"
          },
          "timestamp": {
            "description": "The date and time at which the error occurred.\n",
            "type": "string",
            "format": "date-time",
            "readOnly": true
          },
          "retryAfter": {
            "description": "Number of seconds to wait before retrying the request. Present on 429 and 503 responses.\n",
            "type": "integer",
            "readOnly": true,
            "example": 30
          }
        }
      },
      "Pagination": {
        "description": "Pagination metadata",
        "type": "object",
        "required": [
          "pageNumber",
          "pageSize",
          "total"
        ],
        "properties": {
          "pageNumber": {
            "description": "The current page number",
            "type": "integer",
            "minimum": 1,
            "readOnly": true,
            "example": 1
          },
          "pageSize": {
            "description": "The maximum number of items per page",
            "type": "integer",
            "minimum": 1,
            "readOnly": true,
            "example": 10
          },
          "total": {
            "description": "The total number of items",
            "type": "integer",
            "minimum": 0,
            "readOnly": true,
            "example": 2
          }
        }
      },
      "Links": {
        "description": "Pagination navigation links",
        "type": "object",
        "required": [
          "prev",
          "next"
        ],
        "properties": {
          "prev": {
            "description": "URL of the previous page. Blank if currently on the first page.",
            "type": "string",
            "readOnly": true,
            "example": ""
          },
          "next": {
            "description": "URL of the next page. Blank if currently on the last page.",
            "type": "string",
            "readOnly": true,
            "example": ""
          }
        }
      },
      "ProfileId": {
        "type": "string",
        "description": "The unique identifier of a profile.",
        "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
        "minLength": 36,
        "maxLength": 36,
        "example": "16a7490f-86a6-4a14-8ce2-11682230adb6"
      },
      "UserId": {
        "description": "Unique identifier for a user.",
        "type": "string",
        "pattern": "^002[0-9a-f]{23}$",
        "example": "002507f1e1c8e3e9a8b7c5d4e3f2"
      },
      "Email": {
        "description": "A user's email address",
        "type": "string",
        "format": "email"
      },
      "FirstName": {
        "description": "The first name of a user.",
        "type": "string",
        "minLength": 2,
        "maxLength": 255,
        "pattern": "^[^<>\\^@#]*$",
        "example": "John"
      },
      "LastName": {
        "description": "The last name of a user.",
        "type": "string",
        "minLength": 2,
        "maxLength": 255,
        "pattern": "^[^<>\\^@#]*$",
        "example": "Smith"
      },
      "FullName": {
        "description": "The full name of the user (firstName + lastName).",
        "type": "string",
        "example": "John Smith"
      }
    }
  }
}
```