Arguments

gatheringId: (Int!)

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

To request relationships, include the nested relationships and the associated attributes you wish. This query will return the lastName, id, and externalId for each attendee as well as sessions they have chosen, including the id, name, start date and time, and externalId for those sessions.

Query Example

{
  attendees(gatheringId: 4422) {
    firstName
    lastName
    id
    externalId
    bookmarkedAgendaSessions {
      id
      name
      startsAt
      externalId
    }
    surveyResponses {
      id
      createdAt
      updatedAt
      answers {
        id
        question {
          id
          name
          questionData
          questionType
        }
        answer
      }
    }
  }
}

Attributes

firstName (String) Attendee first name. Displayed if present.
lastName (String) Attendee last name. Displayed if present.
prefix_name (String) Attendee honorific (Mr., Ms., Dr.). Displayed if present.
login_email (String) Email used to login. Not displayed.
organization (String) Attendee organization or company. Displayed if present.
job_title (String) Attendee organization or company. Displayed if present.
email (String) Attendee email. Displayed if present. Not related to the login email.
participantTypes (Array of Strings) To add one or more pariticpant types, provide an array of strings containing those participant types. Participant Types are used to control access to content.
telephone (String) Attendee preferred telephone number. Displayed if present.
website (String) Attendee URL. Displayed if present.
twitterHandle (String) Attendee Twitter handle. @ is optional. Displayed if present.
facebookUsername (String) Attendee Facebook username. Not a URL. Displayed if present.
linkedInUrl (String) Attendee LinkedIn URL. Displayed if present.
street (String) Attendee Street (3722 Maplehurst Drive). Displayed if present.
street2 (String) Attendee Street - supplemental (e.g., Suite 181). Displayed if present.
city (String) Attendee last name. Displayed if present.
state (String) Attendee's state or province. Displayed if present.
postalCode (String) Attendee's Postal or ZIP code. Displayed if present.
country (String) Attendee's country. Displayed if present.
badgeCode (String) The code on an Attendee badge that will be scanned to retrieve sales lead information. Not displayed.
leadEmail (String) The email address that will be supplied to a person scanning an attendee badge to retrieve sales lead information. Not displayed.
leadAddress (String) The complete geographic address that will be supplied to a person scanning an attendee badge to retrieve sales lead information. Not displayed.
leadPhone (String) The telephone number that will be supplied to a person scanning an attendee badge to retrieve sales lead information. Not displayed.
biographyHtml (String) Attendee biography in HTML format. Distinct from BiographyText. Displayed if present. Not editable by attendee.
biographyText (String) Attendee biography in text format. Distinct from BiographyHtml. Displayed if present. Editable by attendee.
hidden (Boolean) If this boolean is set to true, this attendee will not be visible in the mobile app and cannot participate socially.
externalId (String) The unqiue ID of the attendee from it\'s source (i.e., the attendee id in your system). Not displayed.
externalSource (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.

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 (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 (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 -X POST https://api.certaintouchpoint.com/graphql -H 'Content-Type: application/graphql' -H 'Authorization: Bearer 123abcveryLongAuthorizationToken456def' -F query='mutation { createAttendee(attendee: { firstName: "David Foster", lastName: "Wallace", photo: "photo_argument"}, gatheringId: 232) { firstName lastName id }' -F photo_argument=@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 -X POST https://api.certaintouchpoint.com/graphql -H 'Content-Type: application/graphql' -H 'Authorization: Bearer 123abcveryLongAuthorizationToken456def' -d '{ mutation { createAttendee(attendee: { firstName: "David Foster", lastName: "Wallace", photo: "data:image/jpg;base64,alongbase64encodedstring"}, gatheringId: 232) { firstName lastName id } }'

 

Retrieving Relationships

assignedAgendaSessions (String) Agenda Sessions that have been preregistered for the Attendee
bookmarksAgendaSessions (String) Agenda Sessions that have been selected by the Attendee
checkedInAgendaSessions (String) Agenda Sessions that the Attendee has checked into

Creating Relationships

To update assigned agenda sessions assignedAgendaSessionIds (Array of Ids) The unqiue ID of the attendee from it\'s source (i.e., the attendee id in your system). Not displayed.