Skip to content
Soljio Docs
Esc
↑↓navigate↵open⌘Jpreview

Get location

Organization-scoped location read. Requires locations.read. Unknown or repeated query parameters are rejected.

GET/locations/{id}
Authorization
AuthorizationBearer token (soljio_sk_<secret>) · headerrequired

Organization-scoped service token created by an owner/admin. Scope requirements are in x-required-scopes; these are service-token grants, not OAuth scopes. Revoked, expired, unknown and suspended-organization credentials all return 401.

Path parameters
idstringrequired

Resource ID within the token organization. Foreign and missing records are indistinguishable.

min length 1 · max length 256
Responses
200

Successful operation.

dataLocationrequired
Show properties
idstringrequired

Opaque Soljio ID. Do not parse or synthesize.

min length 1 · max length 256
organization_idstringrequired

Opaque Soljio ID. Do not parse or synthesize.

min length 1 · max length 256
statusstringrequired
updated_atstring<date-time>required
objectstringrequired
namestringrequired
slugstringrequired
kindstringrequired
timezonestring
addressobjectrequired
Show properties
line_1string
line_2string
citystring
regionstring
postal_codestring
countrystring
request_idstring<uuid>required
400

invalid_request

errorobjectrequired
Show properties
codestringrequired
Allowed:invalid_request
messagestringrequired
request_idstring<uuid>required
401

unauthorized

errorobjectrequired
Show properties
codestringrequired
Allowed:unauthorized
messagestringrequired
request_idstring<uuid>required
403

forbidden

errorobjectrequired
Show properties
codestringrequired
Allowed:forbidden
messagestringrequired
request_idstring<uuid>required
404

not_found

errorobjectrequired
Show properties
codestringrequired
Allowed:not_found
messagestringrequired
request_idstring<uuid>required
405

method_not_allowed

errorobjectrequired
Show properties
codestringrequired
Allowed:method_not_allowed
messagestringrequired
request_idstring<uuid>required
429

rate_limited

errorobjectrequired
Show properties
codestringrequired
Allowed:rate_limited
messagestringrequired
request_idstring<uuid>required
500

internal_error

errorobjectrequired
Show properties
codestringrequired
Allowed:internal_error
messagestringrequired
request_idstring<uuid>required
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.soljio.com/v0/locations/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "data": {
    "id": "string",
    "organization_id": "string",
    "status": "string",
    "updated_at": "2019-08-24T14:15:22Z",
    "object": "location",
    "name": "string",
    "slug": "string",
    "kind": "string",
    "timezone": "string",
    "address": {
      "line_1": "string",
      "line_2": "string",
      "city": "string",
      "region": "string",
      "postal_code": "string",
      "country": "string"
    }
  },
  "request_id": "266ea41d-adf5-480b-af50-15b940c2b846"
}

Was this page helpful?