Skip to main content
GET
/
checkin
/
v1
/
api
/
guests
/
{eventId}
Gets a page of guests for an event.
curl --request GET \
  --url https://api.qflowhub.io/checkin/v1/api/guests/{eventId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Ocp-Apim-Subscription-Key: <api-key>'
[
  {
    "id": "<string>",
    "firstName": "<string>",
    "otherNames": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "plusOnes": 123,
    "admittedPlusOnes": 123,
    "additionalInfo": "<string>",
    "barcode": "<string>",
    "tags": "<string>",
    "createdBy": "<string>",
    "admitted": "2023-11-07T05:31:56Z",
    "blockedDate": "2023-11-07T05:31:56Z",
    "blockedReason": "<string>",
    "eventId": "<string>",
    "validFrom": "2023-11-07T05:31:56Z",
    "validTo": "2023-11-07T05:31:56Z",
    "isGroup": true,
    "discharged": "2023-11-07T05:31:56Z",
    "image": "<string>",
    "customId": "<string>",
    "commsTemplateId": "<string>",
    "correlationId": "<string>"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.qflowhub.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

OAuth 2.0 access token issued by https://identity.qflowhub.io/core. Include as Authorization: Bearer <token>. See the Authentication guide for the token flow.

​
Ocp-Apim-Subscription-Key
string
header
required

Your APIM subscription key. Sent in the welcome email when your account is enabled. Required on every request alongside the bearer token.

Path Parameters

​
eventId
string
required

The ID of the event to return guests for

Response

OK

​
id
string

The ID of the guest (This should be a GUID)

​
firstName
string

The first / given name of the guest

​
otherNames
string

The middle of other names for the guest

​
lastName
string

The last name / surname of the guest

​
email
string

The email address of the guest

​
plusOnes
integer<int32>

How many plus ones the guest has

​
admittedPlusOnes
integer<int32>

How many of the plus ones admitted

​
additionalInfo
string

Additional information for the guest

​
barcode
string

The barcode data for the guest

​
tags
string

Tags groups of guests by common information (comma separated)

​
createdBy
string

The user who created this guest

​
admitted
string<date-time>

The time the guest was admitted

​
blockedDate
string<date-time>

The time the guest was blocked

​
blockedReason
string

The reason the guest was blocked

​
eventId
string

The ID of the event this guest belongs to

​
validFrom
string<date-time>

The time the guest can be admitted from

​
validTo
string<date-time>

The time the guest can be admitted up to

​
isGroup
boolean

If true, all plus ones are checked in along with the guest

​
discharged
string<date-time>

The time the guest was checked out / discharged

​
image
string

The guest's image (optional)

        The image should ideally be under 50kb
        The image should be portrait - 600px x 400px
        The image should be base64 encoded
​
customId
string

The custom ID by which you can identify the guest if you choose not to use ID

​
commsTemplateId
string

Optional. The GUID of a stored comms template to send to this guest after creation. Leave null/empty to skip sending. The template must belong to your client and the same event. Setting this field triggers an asynchronous email send; the result is reported via webhook (comms.sent / comms.failed).

​
correlationId
string

Optional. Opaque string echoed back in the comms webhook payload. Use this to correlate the webhook event with your own records (e.g. an order id) without having to store Qflow guids on your side.