Loading ...

REST API: Get Personas | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Users » REST API: Personas » REST API: Get Personas
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 27

REST API: Get Personas

0 
 /5
0 (0votes)
Open API Guide
GET/api/personas

Returns the personas the caller can see, with optional filters by space, author, and name. Each item carries the persona's settings; its conditions and actions come from Get Persona by PersonaID.

Request

Request Header

HeaderRequiredValueDescription
AuthorizationYESBearer YOUR_TOKENBearer token for the authenticated user. Learn how to create Bearer tokens.

Optional Parameters

ParameterTypeRequiredLocationDescription
SpaceIDIntegerNOQueryLimits the results to personas that add people to this space. A value that is not a number is ignored and every persona is returned.
SortColumnIntegerNOQueryChooses the sort order. Omitted, 0, or 10 sorts by persona name, A to Z. Sending 1 (date created) or 4 (date updated) returns newest first. Any other value leaves the list unsorted.
UserIDIntegerNOQueryLimits the results to personas created or last updated by this user. A value that is not a number is ignored.
SearchNameStringNOQueryFilters personas whose name contains this text.
IsPersonaSpaceBooleanNOQueryDefaults to false. When true and SpaceID is above 0, each persona's EditAbsoluteURL opens that space's persona editor instead of the site one.
ViewTypeIntegerNOQueryApplies only with SpaceID. 1 returns every persona that adds people to the space (default). 2 returns personas whose only space or site role action is adding people to this space. 3 returns personas that add people to this space and to other spaces or roles. Any other number returns every persona, whatever SpaceID says.

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/personas

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "PersonaID": 8,
      "Name": "Human Resources",
      "CreatedBy": 42,
      "UpdatedBy": 42,
      "DateCreated": "2026-01-15T13:01:23.43",
      "LastUpdated": "2026-01-15T13:04:10.27",
      "IsEnabled": true,
      "IncludeActions": true,
      "IsPrivate": false,
      "PersonaMatchCondition": 0,
      "EditAbsoluteURL": "https://your-site.com/personas/addedit/8",
      "DateCreatedString": "01/15/2026",
      "LastUpdatedString": "01/15/2026",
      "RunActionsOnSave": false,
      "CreatedByUserDisplayName": "Jane Doe",
      "UpdatedByUserDisplayName": "Jane Doe",
      "TenantID": 1
    }
  ]
}

Error Response

You do not have sufficient permissions to perform this action.

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestNot returned for a malformed value. A value of the wrong type, such as a SpaceID that is not an integer, is treated as left out, and the call answers 200.Check the values you send. A value of the wrong type is ignored, so it does not narrow the list.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenThis endpoint does not return 403: personas the caller cannot view are left out of the list.Confirm the user has the required roles for this action.
500 Server ErrorInternal failure.Retry later.

Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

  • Sustained Request Rate: Do not exceed 5 API calls per second
  • Sequential Processing: Wait for each request to complete before sending the next in automated workflows
  • Concurrent Connections: If parallel processing is required, limit to 3 or fewer simultaneous requests
  • Response Timeout: Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.

Wiki Index

Pages