List unit tags

GET

/preferences

const url = 'https://agent-dev.azizdubai.com/preferences';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://agent-dev.azizdubai.com/preferences \
  --header 'X-API-Key: <X-API-Key>'

The global list of unit tags (Sea view, High ROI, Quiet area, …).

Authorizations

apiKeyHeader
bearerKey

Responses

200

Tags, sorted by name.

application/json

object

status

required

string

Allowed value: success

data

required

The shape depends on the operation.

data

required

Array<object>

A unit tag from the global catalogue.

object

integer

name

string

created_at

string format: date-time

updated_at

string format: date-time

Example

{
  "status": "success",
  "data": [
    {
      "name": "Sea view"
    }
  ]
}

401

The key is missing (missing api key) or invalid (invalid api key). The latter covers unknown, revoked and deleted keys. Every operation requires a key, so any request without one receives this response.

application/json

object

status

required

string

Allowed value: error

message

required

Human-readable message.

string

Examples

invalid

{
  "status": "error",
  "message": "invalid api key"
}

403

The key is valid, but it is restricted to a list of domains and the request’s Origin (or Referer) does not match any of them; or the key’s agency has no approved licence.

application/json

object

status

required

string

Allowed value: error

message

required

Human-readable message.

string

Examples

{
  "status": "error",
  "message": "origin is not allowed for this api key"
}

{
  "status": "error",
  "message": "agency license is required: upload a company license and wait for its approval"
}

500

An unexpected error. The cause is logged; a generic message is returned.

application/json

object

status

required

string

Allowed value: error

message

required

Human-readable message.

string

Examples

generic

{
  "status": "error",
  "message": "internal server error"
}