List event invitees (GET)

This API allows you to list all the invitees to a specific event and their RSVP status.

Call

In this call, by using the eventResourceGuid you can retrieve the list of users invited to an event and their RSVP status. Using a userResourceGuid will retrieve one specific user and their information. It is also possible to decide how you want the data to be organized in the response.

Payload Organization

  • Page: This field refers to the result page you want to be shown. In other words, the responses for this API are divided into pages that go from 0 to the number of pages needed to show all the records, this parameter allows you to select which page you will have in your response. The default value is page 0.
  • Size: This field refers to the number of records you want displayed on each page. In other words, each response consists of 1 page and several records on that page, this parameter allows you to select the number of records that will be displayed per page. The default value is 1000 records per page.
  • Sort: This field refers to the sorting order you want for the records in the response. To use this parameter you must follow this format: [field name].keyword,asc/desc (firstName.keyword,desc). If no sort parameters are provided, the response will sort them ascending by their ID on the database table, the default order is always ascending.

Response

This API will return a payload in JSON format, listing all the users who were invited to the event and their RSVP status. Ends with the information about the number of records returned, the page that was returned, and the size of the page.

Example

{
  "content": [
    {
      "userResourceGuid": "9530c460-660b-4ad5-80ce-2353ca8c83fd",
      "rsvpStatus": “ATTENDING”
    },
    {
      "userResourceGuid": "5bb7f296-5335-432e-b77f-228abcf3fc7f",
      "rsvpStatus": “NOTATTENDING”
    },
    {
      "userResourceGuid": "7be9493d-192a-456e-8ae6-783d8fbc6119",
      "rsvpStatus": null
    }
  ],
  "pageable": {
    "sort": {
      "sorted": false,
      "unsorted": true,
      "empty": true
    },
    "pageNumber": 0,
    "pageSize": 20,
    "offset": 0,
    "paged": true,
    "unpaged": false
  },
  "last": true,
  "totalElements": 3,
  "totalPages": 1,
  "sort": {
    "sorted": false,
    "unsorted": true,
    "empty": true
  },
  "first": true,
  "number": 0,
  "numberOfElements": 3,
  "size": 20,
  "empty": false
}

*Use gateway-us for the United States region and gateway-uk for the UK region. For the Frankfurt region, simply use gateway.