URI Structure

Prev Next

The iObeya NextGen API uses JSON format for request and response body and communicate using the standards HTTP verbs.

A resource can be manipulated using the corresponding HTTP verb and the following URI structure:

https://CUSTOMER-api.iobeya.com/VERSION/RESOURCE-NAME

  • CUSTOMER: It is your domain prefix (e.g DEMO if your platforme is demo.iobeya.com).

  • VERSION: Some endpoints can have multiple versions, please refer to the API reference to find the correct version of the endpoint.

  • RESOURCE-NAME: The resource you want to manipulate.

For example, to retrieve the list of all the rooms the following request can be performed: GET https://CUSTOMER-api.iobeya.com/v0/rooms