Skip to content
calternal docs

Get Location settings

GET
/api/v1/location
curl --request GET \
  --url https://example.com/api/v1/location \
  --header 'Authorization: Bearer <token>'

Return the caller’s Location settings. The response includes whether Location is enabled, whether Log entries record matching Saved places, the current position, and the confirmed time zone. Route: /api/v1/location. Inputs: . Safe reads can use bounded retries.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
enabled
required
boolean
position
One of:
object
approximate
required

True only for coordinates migrated from the old rounded Auto setting.

boolean
latitude
required
number format: double
longitude
required
number format: double
record_places_on_logs
required
boolean
timezone

The confirmed User zone used when a request has no zone header.

string | null
Examplegenerated
{
  "enabled": true,
  "position": {
    "approximate": true,
    "latitude": 1,
    "longitude": 1
  },
  "record_places_on_logs": true,
  "timezone": "example"
}

401

Section titled “401”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

409

Section titled “409”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}