SmartGare
API referenceEndpoints

Search destinations

Returns destinations matching optional text and status filters.

GET/referential/v1/destinations

Returns destinations matching optional text and status filters.

AuthorizationBearer <token>

In: header

Query Parameters

search?string

Matches part of a code or display name.

Defaultnull
status?string

Destination lifecycle status.

Defaultnull

Value in

  • "ACTIVE"
  • "SUSPENDED"
sort?string

Result ordering.

Defaultnull

Value in

  • "codeAsc"
  • "codeDesc"
  • "newest"
  • "oldest"
page?integer

Zero-based page index.

Formatint32
Range0 <= value
Defaultnull
size?integer

Page size, at most 200.

Formatint32
Range0 <= value <= 200
Defaultnull

Response Body

*/*

curl -X GET "https://example.com/referential/v1/destinations"
{  "data": [    {      "id": "string",      "code": "string",      "name": "string",      "namesByLocale": {        "property1": "string",        "property2": "string"      },      "latitude": 0.1,      "longitude": 0.1,      "status": "string",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "page": 0,  "size": 0,  "total": 0}