Loading ...

REST API: Get Event Resource Availability | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Content » REST API: Events » REST API: Event Resources » REST API: Get Event Resource Availability
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 23

REST API: Get Event Resource Availability

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

Check whether an event resource is available at a certain time.

Request

Request Header

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

Required Parameters

ParameterTypeRequiredLocationDescription
StartDateTimeISOStringYESQueryStart of the period to check, ISO 8601; a value without a time zone designator is read in the calling user's time zone. Without it the endpoint answers 200 with ResponseMessage Content not found. and no ResponseData.
EndDateTimeISOStringYESQueryEnd of the period to check, ISO 8601; a value without a time zone designator is read in the calling user's time zone. Without it the endpoint answers 200 with ResponseMessage Content not found. and no ResponseData.
ResourceIDIntegerYESQueryUnique ID of the event resource to check availability of

Optional Parameters

ParameterTypeRequiredLocationDescription
EventIDIntegerNOQueryID of an existing event to leave out of the check, so that event's own booking does not count as a conflict.

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/events/resources/availability?resourceID=14&startDateTimeISO=2026-01-01T12:00:00Z&endDateTimeISO=2026-02-01T00:00:00Z

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": true
}

Error Response

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

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestOne or more required fields are missing or invalid. (startDateTimeISO, endDateTimeISO, resourceID)Verify the request payload against the required parameters.
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.
200 with ResponseMessage Content not found.StartDateTimeISO or EndDateTimeISO is missing or not a date; IsError stays false and there is no ResponseData.Send both dates in ISO 8601 form.

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