Attendees Query is a GraphQL query that retrieves attendee data for a specified gathering.
Arguments
Gathering identifier is a non-null integer input that identifies the gathering.
filters is a Filter input to apply constraints on resource creation and update times.
createdAfter returns resources created at or after the specified datetime, inclusive.
Datetime must be in ISO 8601 format.
createdBefore returns resources created at or before the specified datetime, inclusive.
Datetime must be in ISO 8601 format.
updatedAfter returns resources updated at or after the specified datetime, inclusive.
Datetime must be in ISO 8601 format.
updatedBefore returns resources updated at or before the specified datetime, inclusive.
Datetime must be in ISO 8601 format.
CURL Request
curl -X POST https://api.certaintouchpoint.com/graphql \
-H 'Content-Type: application/graphql' \
-H 'Authorization: Bearer 123abcveryLongAuthorizationToken456def' \
-d '{ attendees(gatheringId: 232) { firstName lastName } }'
Example Response
{
"data": {
"attendees": [{
"id": "123",
"firstName": "Peter",
"lastName": "Rabbit"
}]
}
}
Nested Relationships
Nested Relationships explain how to request related data for attendees.
This query returns lastName, id, and externalId for each attendee.
The query also returns sessions each attendee has chosen, including id, name, start date and time, and externalId for those sessions.
Query Example
{
attendees(gatheringId: 421, , filters: {createdAfter: "2025-05-13T12:00:00Z"}) { ... }) {
firstName
lastName
id
externalId
createdAt
updatedAt
bookmarkedAgendaSessions {
id
name
startsAt
externalId
}
surveyResponses {
id
createdAt
updatedAt
answers {
id
question {
id
name
questionData
questionType
}
answer
}
}
field_values {
id
value
field_definition {
id
field_type
}
}
}
}
Attributes
firstName is a String. Attendee first name. Displayed if present.
lastName is a String. Attendee last name. Displayed if present.
prefix_name is a String. Attendee honorific (Mr., Ms., Dr.). Displayed if present.
login_email is a String. Email used to login. Not displayed.
organization is a String. Attendee organization or company. Displayed if present.
job_title is a String. Attendee organization or company. Displayed if present.
email is a String. Attendee email. Displayed if present. Not related to the login email.
participantTypes is an Array of Strings. To add one or more participant types, provide an array of strings containing those participant types. Participant Types are used to control access to content.
telephone is a String. Attendee preferred telephone number. Displayed if present.
website is a String. Attendee URL. Displayed if present.
twitterHandle is a String. Attendee Twitter handle. @ is optional. Displayed if present.
facebookUsername is a String. Attendee Facebook username. Not a URL. Displayed if present.
linkedInUrl is a String. Attendee LinkedIn URL. Displayed if present.
street is a String. Attendee Street (3722 Maplehurst Drive). Displayed if present.
street2 is a String. Attendee Street - supplementary (e.g., Suite 181). Displayed if present.
city is a String. Attendee last name. Displayed if present.
state is a String. Attendee's state or province. Displayed if present.
postalCode is a String. Attendee's Postal or ZIP code. Displayed if present.
country is a String. Attendee's country. Displayed if present.
badgeCode is a String. The code on an Attendee badge that will be scanned to retrieve sales lead information. Not displayed.
leadEmail is a String. The email address that will be supplied to a person scanning an attendee badge to retrieve sales lead information. Not displayed.
leadAddress is a String. The complete geographic address that will be supplied to a person scanning an attendee badge to retrieve sales lead information. Not displayed.
leadPhone is a String. The telephone number that will be supplied to a person scanning an attendee badge to retrieve sales lead information. Not displayed.
biographyHtml is a String. Attendee biography in HTML format. Distinct from BiographyText. Displayed if present. Not editable by attendee.
biographyText is a String. Attendee biography in text format. Distinct from BiographyHtml. Displayed if present. Editable by attendee.
hidden is a Boolean. If this boolean is set to true, this attendee will not be visible in the mobile app and cannot participate socially.
externalId is a String. The unique ID of the attendee from its source (i.e., the attendee id in your system). Not displayed.
externalSource is a String. External data source of the attendee. If you have created this attendee in the Touchpoint system, Touchpoint will define the external_source. Not displayed.
createdAt is a Date! The timestamp indicating when the resource was created. Returned in ISO 8601 UTC format.
updatedAt is a Date! The timestamp indicating when the resource was last updated. Returned in ISO 8601 UTC format.
Providing a Photo/Avatar
You may supply an attendee photo in several ways. Using the photoUrl attribute, you may supply a URL. Using the photo attribute you may supply either a Base64 encoded string or an image file using the multipart/form-data content type. An image file is preferred to the Base64 string as it will be smaller.
photoUrl is a String. If the photo resides at a publicly available URL, you may provide that URL here. (.jpg or .png format). The image at that URL will be copied into the Touchpoint system.
photo is a DataUpload. Choose multipart file (preferred) and Base64. To provide the photo as a file, you should use the multipart/form-data content type. For example: (curl example) This shows how to attach a file named photo.jpg. Notice that the value of the photo attribute is the name of the argument used to refer to the photo file. To provide the photo file as a Base64 encoded string, prefix the photo string with the information: data:<mime type>;base64,<encoded data>. For example: (curl example)
Retrieving Relationships
assignedAgendaSessions is a String. Agenda Sessions that have been preregistered for the Attendee.
bookmarksAgendaSessions is a String. Agenda Sessions that have been selected by the Attendee.
checkedInAgendaSessions is a String. Agenda Sessions that the Attendee has checked into.
Creating Relationships
To update assigned agenda sessions, assignedAgendaSessionIds is an Array of Ids. The unique ID of the attendee from its source (i.e., the attendee id in your system). Not displayed.
Was this article helpful?
Related articles
- createAttendee
- Agenda Sessions Query
- Gatherings Query
- Checkin Query
- Meeting Invites
Comments