Skip to main content
GET
/
v1
/
locations
Get locations
curl --request GET \
  --url https://api.wellapp.ai/v1/locations \
  --header 'Authorization: <authorization>'
{
  "data": [
    {
      "type": "location",
      "id": "loc1",
      "attributes": {
        "full_address": "123 Turing Way, London, Greater London, E1 6AN, GB",
        "address_line1": "123 Turing Way",
        "address_line2": "",
        "city": "London",
        "region": "Greater London",
        "postal_code": "E1 6AN",
        "country": "GB",
        "latitude": 37.7749,
        "longitude": -122.4194,
        "is_primary": true,
        "is_registered": true,
        "created_at": "2025-06-01T10:00:00Z",
        "updated_at": "2025-06-01T10:00:00Z"
      },
      "relationships": {
        "persons": {
          "data": [
            {
              "type": "people",
              "id": "people1"
            }
          ]
        },
        "companies": {
          "data": [
            {
              "type": "company",
              "id": "company_tenant"
            }
          ]
        },
        "workspaces": {
          "data": [
            {
              "type": "workspace",
              "id": "workspace_tenant"
            }
          ]
        }
      }
    }
  ],
  "included": [
    {
      "type": "people",
      "id": "people1",
      "attributes": {
        "first_name": "Alan",
        "last_name": "Turing",
        "full_name": "Alan Turing",
        "created_at": "2025-06-01T09:00:00Z",
        "updated_at": "2025-06-01T09:00:00Z"
      }
    },
    {
      "type": "company",
      "id": "company_tenant",
      "attributes": {
        "name": "Tech Innovations Ltd",
        "description": "Leading technology research company",
        "locale": "en",
        "domain_name_primary_link_url": "techinnovations.com",
        "tax_id": {
          "value": "GB123456789",
          "type": "VAT"
        },
        "registration": {
          "trade_name": "Tech Innovations",
          "registered_name": "Tech Innovations Limited"
        },
        "registration_number": {
          "business_type": "Ltd",
          "value": "12345678",
          "registry_name": "Companies House",
          "registry_country": "GB"
        },
        "created_at": "2025-05-15T08:00:00Z",
        "updated_at": "2025-05-15T08:00:00Z"
      }
    },
    {
      "type": "workspace",
      "id": "workspace_tenant",
      "attributes": {
        "name": "UK Operations Workspace",
        "description": "Workspace for UK-based operations and teams",
        "avatar_color": "#2E86AB",
        "external_workspace_id": "uk_ops_ws_001",
        "auto_extract_enabled": true,
        "created_at": "2025-05-20T10:00:00Z",
        "updated_at": "2025-05-20T10:00:00Z"
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 20,
      "current_page": 1,
      "total_pages": 1
    }
  }
}

​
Complex Usage Example

​
Advanced Location Filtering with Full Context

This example demonstrates advanced filtering with multiple parameters, relationship inclusion, status filtering, and sorting for retrieving locations: 
curl -X GET "https://api.well.com/v1/locations?include=persons,companies,workspaces&workspace_id=550e8400-e29b-41d4-a716-446655440000&company_id=550e8400-e29b-41d4-a716-446655440001&is_registered=true&is_primary=true&created_at_from=2023-01-01T00:00:00Z&created_at_to=2023-12-31T23:59:59Z&updated_at_from=2023-06-01T00:00:00Z&sort=-created_at&page[limit]=20&page[cursor]=eyJjcmVhdGVkX2F0IjoiMjAyMy0xMS0wMlQxMDozMDowMFoiLCJpZCI6ImxvY2F0aW9uOS11dWlkIn0=" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Headers

​
Authorization
string
required

Bearer token for authentication

Query Parameters

​
include
string

Comma-separated list of related resources to include with detailed attributes. Available options: persons, companies, workspaces

​
created_at_from
string<date-time>

Filter locations created on or after this datetime (ISO 8601 format)

​
created_at_to
string<date-time>

Filter locations created on or before this datetime (ISO 8601 format)

​
updated_at_from
string<date-time>

Filter locations updated on or after this datetime (ISO 8601 format)

​
updated_at_to
string<date-time>

Filter locations updated on or before this datetime (ISO 8601 format)

​
workspace_id
string<uuid>

Filter locations by workspace UUID

​
external_workspace_id
string

Filter locations by external workspace identifier

​
people_id
string<uuid>

Filter locations by person UUID

​
company_id
string<uuid>

Filter locations by company UUID

​
is_registered
boolean

Filter locations by registration status (true/false)

​
is_primary
boolean

Filter locations by primary status (true/false)

​
sort
enum<string>

Sort locations by date field. Use '-' prefix for descending order (e.g., '-created_at' for newest first)

Available options:
created_at,
updated_at,
-created_at
​
page[limit]
integer
default:20

Number of locations per page (1-100)

Required range: 1 <= x <= 100
​
page[cursor]
string

Cursor for pagination to get next set of results

Response

Locations retrieved successfully

​
data
object
⌘I