Loading ...

REST API: Get Persona by PersonaID | Axero Documentation

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

REST API: Get Persona by PersonaID

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

Returns one persona with its settings, conditions, and actions.

Request

Request Header

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

Required Parameters

ParameterTypeRequiredLocationDescription
PersonaIDIntegerYESPathUnique identifier for a specific Persona

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

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

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,
    "PersonaConditions": [
      {
        "ConditionID": 10,
        "PersonaID": 8,
        "ProfileFieldID": 142,
        "ConditionValue": "611",
        "CreatedBy": 42,
        "UpdatedBy": 42,
        "LastUpdated": "2026-01-15T13:04:10.27",
        "ConditionOperatorType": 0,
        "ParentID": 0,
        "PersonaMatchCondition": 0,
        "TenantID": 1
      }
    ],
    "PersonaActions": [
      {
        "ActionID": 4,
        "PersonaID": 8,
        "ActionValue": "291",
        "CreatedBy": 42,
        "UpdatedBy": 42,
        "LastUpdated": "2026-01-15T13:04:10.27",
        "ActionType": 1,
        "Index": 0,
        "TenantID": 1
      }
    ],
    "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

{
  "Message": "The request is invalid."
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestPersonaID in the path is not an integer.Send the persona's numeric ID.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenThe persona is private and the caller cannot manage it. The body is empty.Confirm the caller can manage personas for the site or for the persona's space.
200 with ResponseData nullNo persona has that ID. IsError is false, ResponseMessage reads Content not found., and ResponseData is left out.Check the PersonaID.
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