Skip to main content
GET
Retrieve a location

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organization_id
string
required

Organization identifier.

Required string length: 24
Pattern: ^[0-9a-f]{24}$
location_id
string<uuid>
required

Location Id (FWS Location.Oid).

Required string length: 36
Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Query Parameters

fields
string

Response fields separated by commas.

Maximum string length: 2048

Response

Location retrieved successfully.

id
string<uuid>

Location Id (FWS Location.Oid).

name
string | null

Location name.

address
string | null

Location address.

latitude
number | null

Location latitude.

longitude
number | null

Location longitude.

organization_id
string | null

Associated Portal organization Id.

Required string length: 24
Pattern: ^[0-9a-f]{24}$