Participant

Endpoint to retrieve data for participants.

Finds participants by filtering a specific conference(frame)

get

Gets Participant objects.

Authorizations
tokenstringRequired

Api key has to be used to authenticate against the server. The token parameter has must be sent in the header

Path parameters
idinteger · int64Required

Id of the conference the participants are loaded for.

Query parameters
changed-afterstring · ISO-8601Optional

Filter to limit returned participant list to participants changed after this date (not including the given timestamp itself).

includestring · enumOptional

Comma separated list of related or additional data that should be fetched as well.

Possible values:
Responses
200

Successful response

application/json
get
/rest-api/v2/frame/{id}/participant/
GET /rest-api/v2/frame/{id}/participant/ HTTP/1.1
Host: 
token: YOUR_API_KEY
Accept: */*
{
  "meta": {
    "changed-until": "text"
  },
  "data": [
    {
      "id": 1,
      "firstname": "text",
      "lastname": "text",
      "title": "text",
      "foa": "text",
      "email": "text",
      "company": "text",
      "department": "text",
      "phone": "text",
      "city": "text",
      "street": "text",
      "zip": "text",
      "country": "text",
      "language": "text",
      "booking-state": "valid",
      "booking-barcode": "text",
      "merged-from": [
        1
      ],
      "efn": "text",
      "member": [
        {
          "id": 1,
          "external-reference": "text",
          "number": "text"
        }
      ],
      "cart-event": [
        {
          "id": 1,
          "external-reference": "text",
          "name": "text"
        }
      ],
      "badge": {
        "id": 1,
        "number": "text",
        "printTime": "text"
      },
      "eav": [
        {
          "key": "text",
          "value": "text"
        }
      ]
    }
  ]
}

Was this helpful?