Loading ...

REST API: Get Persona by PersonaID | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Users » REST API: Personas » REST API: Get Persona by PersonaID
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 2

REST API: Get Persona by PersonaID

0 
 /5
0 (0votes)

REST API: GET Persona By PersonaID

GET /api/personas/PersonaID

Used to get the properties and information of persona by its Persona ID. Valid for Communifire version 8 and above.

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
8.0 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)

Communifire REST API key for the Communifire portal you are making the call for.
PersonaID Used in the request URL as a path parameter Unique identifier for a specific Persona.

Example Request

GET https://myintranet.communifire.com/api/personas/1

Example Response

{
    "IsError": false,
    "ResponseMessage": "",
    "ResponseData": [
        {
            "PersonaID": 1,
            "Name": "Test Persona 1",
            "CreatedBy": 376,
            "UpdatedBy": 376,
            "LastUpdated": "2022-04-20T15:18:57.767",
            "IsEnabled": true,
            "IncludeActions": true,
            "PersonaMatchCondition": 0,
            "PersonaConditions": [
                {
                    "ConditionID": 1,
                    "PersonaID": 1,
                    "ProfileFieldID": 67,
                    "ConditionValue": "610",
                    "CreatedBy": 376,
                    "UpdatedBy": 376,
                    "LastUpdated": "2022-04-20T15:18:57.767",
                    "ConditionOperatorType": 0,
                    "TenantID": 1
                }
            ],
            "PersonaActions": [
                {
                    "ActionID": 1,
                    "PersonaID": 1,
                    "ActionValue": "291",
                    "CreatedBy": 376,
                    "UpdatedBy": 376,
                    "LastUpdated": "2022-04-20T15:18:57.77",
                    "ActionType": 1,
                    "TenantID": 1
                }
            ]
        }
    ]
}

is returned as ResponseData.

 

Please Note Pass application/json as the content type in the header of your request.

Wiki Index

Pages

Intranet Software