Loading ...

REST API: Get Event Resources | Axero Documentation

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

REST API: Get Event Resources

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

Get a list of event resources

Request

Request Header

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

Optional Parameters

ParameterTypeRequiredLocationDescription
ResourceTypeIDIntegerNOQueryUnique ID of the resource type to filter by
KeywordStringNOQuerySearch term to filter results by
StartPageIntegerNOQueryPage of results to return. Default: 1.
PageLengthIntegerNOQueryNumber of results to return per page. Default: 10.
SpaceIDIntegerNOQueryReturn only the resources available in this space. Omit for every space.

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/events/resources?Keyword=conference&StartPage=1&PageLength=10

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "ResourceID": 30,
      "ResourceName": "API Validate matrix room e338",
      "Location": "L",
      "Description": "m",
      "EventResourceTypeID": 1,
      "Type": {
        "EventResourceTypeID": 1,
        "ResourceKey": "RoomText",
        "IsRoom": true,
        "TenantID": 0
      },
      "CalendarURL": "/events/resources/30/calendar",
      "SpaceIDCSV": "313",
      "DateCreated": "0001-01-01T00:00:00",
      "TenantID": 1
    }
  ]
}

Error Response

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

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestOne or more required fields are missing or invalidVerify the request payload against the required parameters
401 UnauthorizedMissing or invalid Bearer tokenCheck token validity Learn how to create Bearer tokens →
403 ForbiddenUser does not have sufficient permissionsConfirm the user has the required roles for this action
500 Server ErrorInternal failureRetry 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