Get Location by id
get
/v1/locations/{location_id}Fetches a single location row by id from the records pipeline, scoped to the workspace. Read-only; no side effects. 404 when absent or out of scope.
Requires a bearer token: Authorization: Bearer <token>.
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
| location_id | string <uuid> | Yes | Public UUID of the location.e.g. 0a1b2c3d-4e5f-4607-8819-2a3b4c5d6e7f |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
| workspaceId | string <uuid> | No | Workspace to scope to; defaults to the token's workspace.e.g. 8f6b2c10-4a1e-4d2b-9c3a-1f0e7a5b6c21 |
Request
cURL
curl -X GET https://api.wellapp.ai/v1/locations/{location_id} \
-H "Authorization: Bearer $WELL_API_TOKEN"Responses
200 — The location row.
{
"data": {
"type": "location",
"id": "0a1b2c3d-4e5f-4607-8819-2a3b4c5d6e7f",
"attributes": {
"full_address": "548 Market St, San Francisco, CA 94104, US",
"address_line1": "548 Market St",
"address_line2": "Suite 320",
"city": "San Francisco",
"region": "CA",
"postal_code": "94104",
"country": "US"
},
"relationships": {
"company_locations": {
"data": [
{
"type": "company_location",
"id": "00000000-0000-4000-8000-000000000001"
}
]
},
"person_locations": {
"data": [
{
"type": "person_location",
"id": "00000000-0000-4000-8000-000000000001"
}
]
}
}
}
}401 — Unauthorized
{
"code": "UNAUTHORIZED",
"status": 401,
"title": "Unauthorized",
"message": "See title.",
"meta": {
"trace_id": "a1b2c3",
"log_id": "a1b2c3"
}
}403 — Forbidden
{
"code": "FORBIDDEN",
"status": 403,
"title": "Forbidden",
"message": "See title.",
"meta": {
"trace_id": "a1b2c3",
"log_id": "a1b2c3"
}
}404 — Not Found
{
"code": "NOT_FOUND",
"status": 404,
"title": "Not Found",
"message": "See title.",
"meta": {
"trace_id": "a1b2c3",
"log_id": "a1b2c3"
}
}