iotoms Docs

Get a venue

GET
/api/v1/catalog/business/venues/{id}

Returns one venue by its ID, with its name and status, or 404 if it does not exist. The venue is returned directly, not inside the usual status/message envelope.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

id*integer

ID of the record.

Formatint64

Response Body

OK

*/*
  1. response
id?|

Venue (site) ID.

Formatint64
name*string

Venue name.

status*string

Venue status: ACTIVE, INACTIVE, ARCHIVED or DELETED.

Value in"ACTIVE""INACTIVE""ARCHIVED""DELETED"
modifiedTime*string

When the venue was last changed.

Formatdate-time
Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/catalog/business/venues/0'
Example Response
{  "id": 0,  "name": "string",  "status": "ACTIVE",  "modifiedTime": "2019-08-24T14:15:22Z"}