iotoms Docs

List venues

GET
/api/v1/catalog/business/venues

Returns venues sorted by name. Use query to search names (case-insensitive, partial match). Paginated with 0-based page and size (1 to 100, default 20).

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Query Parameters

query?string

Search text; returns venues whose name contains it (case-insensitive). Omit to list all.

page?integer

Page number, starting at 0. See Paging.

Formatint32
Default0
size?integer

Number of records per page.

Formatint32
Default20

Header Parameters

Response Body

OK

*/*
  1. response
status*string

Outcome of the call: SUCCESS when the request worked, ERROR when it did not.

message*string

Short human-readable message describing the result, for logs or display; do not parse it.

data?

One page of venues, sorted by name, with paging details.

Example Request
curl -X GET 'https://beta.iotoms.com/api/v1/catalog/business/venues'
Example Response
{  "status": "string",  "message": "string",  "data": {    "content": [      {        "id": 0,        "name": "string",        "status": "ACTIVE",        "modifiedTime": "2019-08-24T14:15:22Z"      }    ],    "page": 0,    "size": 0,    "totalElements": 0,    "totalPages": 0,    "last": true  }}