List

GET /locations

This endpoint retrieves locations with optional organization_id query parameter.

Request

Query Parameters
- organization_id (optional)
- with_attribution_script_install(optional): Pass this param (as shown in example below) to fetch those practices that has installed the TC attribution script on their websites.

{
    "q": {
        "with_attribution_script_install": true
    }
}

Response

The response is in JSON format and follows the schema below:

{
    "data": [
        {
            "id": "string",
            "type": "string",
            "attributes": {
                "title": "string",
                "email": "string",
                "website": "string",
                "pms_type": "string",
                "last_sync": "string",
                "data_provider": "string",
                "business_hours_weekly_summary": [
                    {
                        "day": "string",
                        "open": "string",
                        "hours": 0
                    }
                ],
                "name": "string",
                "phone_number": "string",
                "country": "string",
                "data_provider_id": "string",
                "third_party_identifier": {
                    "data": [{
                        "id": "number",
                        "type": "string",
                        "attributes": {
                            "individual_id": "number",
                            "individual_type": "string",
                            "external_id": "string"
                        }
                    }
                }]
            }
        }
    ]
}

organization_id is optional. If provided, the request returns locations under the specified organization within the consulting firm. If omitted, it returns all locations across all organizations under the consulting firm.

Authentication

Organizations

Locations

GET /locations

Request

Response

​GET /locations

​Request

​Response

GET /locations

Request

Response