Loading ...

REST API: Get Guest Attendees | Axero Documentation

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

REST API: Get Guest Attendees

0 
 /5
0 (0votes)
Open API Guide
GET/api/events/guestattendees

Get the external guests of an event who have the attendance type you name in Attendance. External guests are people on the event who are not members of the site. The response is a plain list of these guests, not the standard response with IsError, ResponseMessage, and ResponseData. When no guest matches, or no event has that ID, the response is null instead of a list.

Request

Request Header

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

Required Parameters

ParameterTypeRequiredLocationDescription
EventIDIntegerYESQueryUnique ID of the event
AttendanceIntegerYESQueryAttendance type to return: 1 = Attending, 2 = Maybe attending, 3 = Not attending, 5 = Awaiting response. 4 (All) is not a filter here. No guest is stored with that type, so the response is null. Refer to REST API: Event Attendance Types. Without Attendance, the request is answered by Get Event instead, which returns that event's details, or IsError true (Not a valid eventID.) when no event has that ID.

Optional Parameters

ParameterTypeRequiredLocationDescription
InstanceStringNOQueryFor a recurring event, the start of one occurrence, as an ISO 8601 date and time in UTC such as 2026-11-17T21:00:00Z. The list then includes guests added to that occurrence only, along with guests on the whole series. Without Instance, guests added to a single occurrence are left out. A value that is not a date answers 500.

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/events/guestattendees?EventID=153&Attendance=1

Success Response

[
  {
    "UserInfoDisplayName": "sally ",
    "AvatarImageURL": "https://your-site.com/assets/Themes/default/images/avatar-default.jpg",
    "UserID": 1057,
    "BlogID": 0,
    "DateJoined": "0001-01-01T00:00:00",
    "Email": "sally@acme.com",
    "EmailRecieve": 3,
    "SpaceDigestOption": 0,
    "InvitationID": 1,
    "IsActivated": true,
    "IsAnonymous": false,
    "IsUserLocked": false,
    "IsBanned": false,
    "IsConfirmed": false,
    "IsContactInfoVisible": false,
    "IsFeatured": false,
    "IsIsolated": false,
    "IsProfileCompleted": false,
    "IsOptInPromotionalEmails": false,
    "IsPasswordEncrypted": false,
    "MediaServerID": 0,
    "MembershipStatus": 0,
    "NumBlogPosts": 0,
    "NumPosts": 0,
    "PMNotification": false,
    "Points": 0,
    "RankID": 0,
    "RoleID": 0,
    "ShowEmail": false,
    "CRMUserContactID": 1057,
    "HasJoinedViaThirdPartyLogin": false,
    "IsWindowsADUser": false,
    "LastChatActivityDate": "0001-01-01T00:00:00",
    "UserPresenceStatus": 0,
    "IsPasswordHashed": false,
    "InOrgChart": false,
    "AttendanceType": 1,
    "IsOrganizer": false,
    "ConnectionStatus": 0,
    "CanChat": false
  },
  {
    "UserInfoDisplayName": "janice ",
    "AvatarImageURL": "https://your-site.com/assets/Themes/default/images/avatar-default.jpg",
    "UserID": 1058,
    "BlogID": 0,
    "DateJoined": "0001-01-01T00:00:00",
    "Email": "janice@acme.com",
    "EmailRecieve": 3,
    "SpaceDigestOption": 0,
    "InvitationID": 4,
    "IsActivated": true,
    "IsAnonymous": false,
    "IsUserLocked": false,
    "IsBanned": false,
    "IsConfirmed": false,
    "IsContactInfoVisible": false,
    "IsFeatured": false,
    "IsIsolated": false,
    "IsProfileCompleted": false,
    "IsOptInPromotionalEmails": false,
    "IsPasswordEncrypted": false,
    "MediaServerID": 0,
    "MembershipStatus": 0,
    "NumBlogPosts": 0,
    "NumPosts": 0,
    "PMNotification": false,
    "Points": 0,
    "RankID": 0,
    "RoleID": 0,
    "ShowEmail": false,
    "CRMUserContactID": 1058,
    "HasJoinedViaThirdPartyLogin": false,
    "IsWindowsADUser": false,
    "LastChatActivityDate": "0001-01-01T00:00:00",
    "UserPresenceStatus": 0,
    "IsPasswordHashed": false,
    "InOrgChart": false,
    "AttendanceType": 1,
    "IsOrganizer": false,
    "ConnectionStatus": 0,
    "CanChat": false
  }
]

Error Response

{
  "Message": "The request is invalid."
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestEventID is missing or not an integer, or Attendance is not an integer (The request is invalid.).Check the request against the required parameters.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenThe caller is not a site administrator and cannot view the event.Confirm the caller can view the event.
500 Server ErrorInstance is not a date. The body is empty.Send Instance as an ISO 8601 date and time, or leave it out.
200 with the eventAttendance was left out, so the request matches Get Event and returns that event's details, with IsError false, instead of the guest attendees. When no event has that EventID, the answer is IsError true (Not a valid eventID.).Send Attendance.

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