V3 Get a List of Personas

Returns the list of all personas on the Encompass instance. Details include basic information, such as persona ID and name, whether default access is enabled, whether the persona is internal and/or external, and displayOrder in the list of personas.

Usage Notes

  • If the 'limit' parameter value is not provided, the API defaults to 100 records per page.
  • If the 'limit' parameter value provided is between 1 and 1000, the API returns that number of records per page, up to 1000.
  • If the 'limit' parameter value provided is greater than 1000, the API returns up to 1000 records per page.
Query Params
string

The type of persona to return. Valid values: Internal, External, InternalAndExternal

integer

Pass this value for paginating results. Default is 0.

integer

Pass this value for limiting how many records should be returned on each page. Default Limit is 100. Max limit is 1000.

string

Filter query param is used to filter the results by the given attribute. Currently, only the Name can be filtered. Examples:
- Contains: filter=name:'Marketing'
- Exact: filter=name='Marketing'

Headers
string
required

Bearer token.

Responses

400

Bad Request

403

Forbidden

Language
URL
Response
Choose an example:
application/json