Locations
Was this helpful?
Was this helpful?
The tenant that the caller is acting upon.
Please note that this value is always lowercase.
^[a-z][a-z0-9]+$The location unique identifier.
Comma-separated list of fields to return in the response. If not specified, all fields are returned.
name,typeThe tenant that the caller is acting upon.
Please note that this value is always lowercase.
^[a-z][a-z0-9]+$The location unique identifier.
No content
The tenant that the caller is acting upon.
Please note that this value is always lowercase.
^[a-z][a-z0-9]+$The page number to be retrieved where the size of the pages must be specified by the pageSize parameter. The number of the first page is 1.
1The number of documents being retrieved on the page.
16Fields to sort the response data by following order of the parameters from left to right. Can contain multiple fields in format: field name:sort direction separated by a comma. The colon with sort direction parameter is redundant and descending order is taken only if it is equal to desc or DESC. Ascending order is considered in any other case.
name,metadata.createdAt:descQuery param for filtering entities by specified type. Examples of query params which are supported:
| Q Param | Description |
|---|---|
name:"Exact match" |
find an entity with name field with Exact match value |
name:~John |
find an entity with name field containing John value |
locDescription.fr:"Description traduction française 02" |
find an entity with localized locDescription field with Description traduction française 02 value in french language |
primary:true |
find an entity with primary field with true value |
metadata.createdAt:(>"2019-01-06T10:29:30.602Z" AND <"2020-01-07T10:29:30.602Z") |
find an entity with metadata.createdAt field with value between 2019-01-06T10:29:30.602Z and 2020-01-07T10:29:30.602Z |
name:exists |
find an entity with existing name field |
name:null |
find an entity with non-existing name field |
name:missing |
find an entity with non-existing name field |
name:"John" surname:~Smith |
find an entity with name exactly equals to John and surname containing Smith value |
name:("John","Jack","James") |
find an entity with name field with one of the following value: John or Jack or James |
name:~johnComma-separated list of fields to return in the response. If not specified, all fields are returned.
name,typeLocation name. When specified, only locations containing the specified name will be returned.
Note: When filtering the results with this field, the contains operator is used. The operator is case-insensitive.
The type of the location. When specified, only locations of the specified type will be returned.
Note: When filtering the results with this field, the equals operator is used.
The email of the contact details of the location. When specified, only locations with contact details containing the specified email will be returned.
Note: When filtering the results with this field, the contains operator is used. The operator is case-insensitive.
The phone number of the contact details of the location. When specified, only locations with contact details containing the specified phone number will be returned.
Note: When filtering the results with this field, the contains operator is used. The operator is case-insensitive.
The address of the contact details of the location. When specified, only locations with contact details containing the specified address will be returned.
Note: When filtering the results with this field, the contains operator is used. The operator is case-insensitive.
The address of the contact details of the location. When specified, only locations with contact details containing the specified city will be returned.
Note: When filtering the results with this field, the contains operator is used. The operator is case-insensitive.
The address of the contact details of the location. When specified, only locations with contact details containing the specified state will be returned.
Note: When filtering the results with this field, the contains operator is used. The operator is case-insensitive.
The postcode of the contact details of the location. When specified, only locations with contact details containing the specified postcode will be returned.
Note: When filtering the results with this field, the contains operator is used. The operator is case-insensitive.
The country code of the contact details of the location. When specified, only locations with contact details having the specified country code will be returned.
Note: When filtering the results with this field, the equals operator is used.
In order to get information how many entities meet a filter requirements, X-Total-Count header has been introduced. The header is optional and its default value is false. It the header is provided and it is true then total count is returned in the X-Total-Count response header. In both cases (X-Total-Count true, false or not provided), the response body has the same format (array of entities). In other words, the information about total count is returned on demand, depending of an existence of X-Total-Count header in a request. Therefore, the X-Total-Count header is not returned if an API consumer didn't ask for it.
falseThe tenant that the caller is acting upon.
Please note that this value is always lowercase.
^[a-z][a-z0-9]+$Custom location identifier. If not provided, it is automatically generated.
^[a-zA-Z0-9_-]$The name of the location,
The type of the location.
The tenant that the caller is acting upon.
Please note that this value is always lowercase.
^[a-z][a-z0-9]+$The location unique identifier.
The name of the location
The type of the location.