Loading ...

REST API: Get Event Attendees | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Content » REST API: Events » REST API: Get Event Attendees
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 27

REST API: Get Event Attendees

0 
 /5
0 (0votes)
Open API Guide
GET/api/events/{EventID}/attendees

Enables administrators and developers to programmatically retrieve a list of event attendees by RSVP type. The response is the bare list of event users, not the response envelope; an empty list when nothing matches.

Request

Request Header

HeaderRequiredValueDescription
AuthorizationYESBearer YOUR_TOKENBearer token for the authenticated user. Learn how to create Bearer tokens.

Required Parameters

ParameterTypeRequiredLocationDescription
EventIDIntegerYESPathUnique ID of the event
SpaceIDUsersIntegerNOQueryFilter attendees by space membership
SpaceAttendanceStringNOQuerySpace-level attendance status to filter by, same values as Attendance.
InstanceStringNOQueryOccurrence date (ISO 8601) of a recurring event. A value that is not a date answers 500.
InstanceOptionIntegerNOQueryFor a recurring event, which occurrences Instance refers to: 1 = All, 2 = Future, 3 = Single (default).

Optional Parameters

ParameterTypeRequiredLocationDescription
AttendanceIntegerNOQueryAttendance type to filter by: 1 = Attending, 2 = Maybe attending, 3 = Not attending, 4 = All, 5 = Awaiting response, 6 = Shared. Refer to REST API: Event Attendance Types.
IsInvitedBooleanNOQuerySet to true to return only users who were invited to the event
KeywordStringNOQuerySearch term to filter the event users by
StartPageIntegerNOQuerySpecifies the starting page of list to be returned
PageLengthIntegerNOQuerySpecifies the number of results to be returned per page

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/events/153/attendees?Attendance=1&StartPage=1&PageLength=50

Success Response

[
  {
    "AttendanceType": 1,
    "AttendanceID": 37086,
    "IsInvited": false,
    "Organizer": false,
    "IsDeleted": false,
    "IsSpaceUser": false,
    "UserName": "jane.doe",
    "MediaServerID": 88,
    "FirstName": "Jane",
    "LastName": "Doe",
    "ProfileURL": "https://your-site.com/people/maxwell",
    "ConnectionStatus": 0,
    "UserID": 630,
    "UserInfoDisplayName": "Alex Morgan",
    "Email": "jane.doe@example.com",
    "AvatarImageURL": "https://your-site.com/Assets/Uploaded-Photos/1/avatar.jpg",
    "IsCommunityUser": true,
    "TenantID": 0
  }
]

Error Response

{
  "IsError": true,
  "ResponseMessage": "Required parameter is missing or invalid.",
  "ResponseData": null
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestEventID in the path is not an integer, or a value is not of the documented type.Check the values.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenUser does not have sufficient permissions.Confirm the user has the required roles for this action.
500 Server ErrorInternal failure.Retry later.

Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

  • Sustained Request Rate: Do not exceed 5 API calls per second
  • Sequential Processing: Wait for each request to complete before sending the next in automated workflows
  • Concurrent Connections: If parallel processing is required, limit to 3 or fewer simultaneous requests
  • Response Timeout: Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.

Wiki Index

Pages