Skip to main content
POST
Search locations — lightweight picker route. Search context: name.

Authorizations

x-api-key
string
header
required

API key for authentication (can be generated in the settings)

Query Parameters

limit
number
default:20

The maximum amount of retrieved items per page

Required range: 1 <= x <= 20
page
number
default:1

The page number to retrieve items from.

Required range: x >= 1

Body

application/json

Search string — matches on the resource-relevant fields

excludeEntityIds
string<uuid>[]

Entity IDs to exclude from results. Use in picker contexts to hide items the user has already linked elsewhere

Response

Matched locations

The response is of type any.