Skip to main content

Get Participant Details

Version: 1.0

This API will help you get details information of participants.

Authenticated access scopes: social.read_bot

Request URI​

  • GET https://apis.harasocial.com/social/participants/{participant_id}.json

Example Request​

curl -X 'GET' \
  'https://apis.harasocial.com/social/participants/2560816460611111.json?channel=facebook&page_id=500725830264711' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer {token}'

Parameters​

participant_id: string

"participant_id" = "2560816460611111"

Page Scoped User ID (PSID) of a participant.

channel: string

"channel" = "facebook"

Channel which participants belong to. Support values: facebook, instagram, zalo

page_id: string

"page_id" = "500725830264711"

Page Id which participants belong to

Response​

A successful Get Participant Details API request returns a JSON string containing details information of this participant.

Example​

{
  "data": {
    "name": "Pham A",
    "participant_id": "2560816460611111",
    "page_id": "500725830264711",
    "channel": "facebook",
    "created_date": "2022-03-04T10:15:32.445Z",
    "custom_fields": [
      {
        "key": "test_custom_field",
        "value": "123",
        "value_double": null,
        "value_datetime": null,
        "value_type": "text"
      },
      {
        "key": "haravan_customer_id",
        "value": null,
        "value_double": 1.0,
        "value_datetime": null,
        "value_type": "number"
      },
      {
        "key": "haravan_last_order_date",
        "value": null,
        "value_double": null,
        "value_datetime": 1660382880,
        "value_type": "datetime"
      }
    ]
  },
  "has_error": false,
  "error_code": null,
  "error_message": null
}

Properties​

data: Participant Object

Participant's info. See Participant Object below.

has_error: bool

True if the request does not meet requirement or validation

error_code: string

The error code information

error_message: string

The error message information

Participant Object​

name: string

"name": "Pham A"

Full name of the participant

participant_id: string

"participant_id": "2560816460611111"

PSID of the participant

page_id: string

"page_id": "500725830264711"

Page Id which the participant belong to

channel: string

"channel": "facebook"

Channel which the participant belong to. Can be zalo, facebook, instagram

created_date: string

"created_date": "2022-03-04T10:15:32.445Z"

Indicate system time when this participant was created.

custom_fields: List<Custom Field Object>

"custom_fields": [
  {
    "key": "test_custom_field",
    "value": "123",
    "value_double": null,
    "value_datetime": null,
    "value_type": "text"
  }
]

Contains list custom fields. See Custom Field Object below.

Custom Field Object​

key: string

"key": "test_custom_field"

Key of the custom field

value_type: string

"value_type": "text"

Type of the value. One of these enums: ["text", "number", "datetime"]

value: string

"value": "abc"

Value when value_type = text

value_double: double?

"value_double": 1.0

Value when value_type = number

value_datetime: long?

"value_datetime": 1660382880

Value when value_type = datetime. Unix Timestamp in Seconds.