List all points of interest

get

https://api.sensos.io/v1/accounts/{accountId}/points-of-interest

Retrieve the points of interest available to an account: the account's own and the built-in ones provided by Sensos. Result order is not specified.

Path Params

accountId

string

required

ID of the account. An account you don't have access to returns 403.

Query Params

name

string

Filter by name. Case-insensitive; supports * as a wildcard (for example *port*).

referenceId

string

Filter by reference ID (exact match).

builtIn

boolean

true returns only built-in points of interest, false only the account's own. Omit to return both.

type

array of objects, unique

Filter by type. Repeat the parameter for several types (?type=Airport&type=SeaPort).

array of strings, unique

Filter by ID. Repeat the parameter for several IDs (?id=a&id=b).

cursor

string

Opaque cursor from metadata.nextCursor of the previous page. Omit it for the first page. Cursors expire after 2 days; an invalid or expired cursor returns 400.

limit

int32

≤ 100

Defaults to 50

Maximum number of results per page. Default 50, maximum 100; values outside 1-100 are clamped.

includeTotal

boolean

Defaults to false

When true, the response includes metadata.total.

Responses

401

Missing, invalid or expired access token. Returned by the gateway with an empty body.

403

The token lacks the required permission, the account is not accessible to the caller, or the tenant is inactive. Returned by the gateway with an empty body.

200Success

400Invalid query parameter or cursor.