Locations

In Whautomate, locations represent distinct branches or physical points of operation within your organization.

These locations serve as identifiable entities, allowing for organized management and segmentation of operations across various geographical or functional areas.

Retrieve Locations: Fetch a list of locations, enabling access to location-based information within the platform.

Get Location By Id: Retrieve detailed information about a specific location using its unique identifier (locationId), facilitating targeted access to location-specific data.

get

Query parameters

limitstringOptional

pagestringOptional

searchTextstringOptional

Header parameters

x-api-keystringRequired

Responses

200

200 response

application/json

idstringOptional

titlestringOptional

addressLine1stringOptional

addressLine2stringOptional

citystringOptional

districtstringOptional

postalCodestringOptional

phonestringOptional

get/v1/locations

GET /v1/locations HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Accept: */*

200

200 response

[
  {
    "id": "text",
    "title": "text",
    "addressLine1": "text",
    "addressLine2": "text",
    "city": "text",
    "district": "text",
    "postalCode": "text",
    "phone": "text"
  }
]

get

Path parameters

locationIdstringRequired

Header parameters

x-api-keystringRequired

Responses

200

200 response

application/json

idstringOptional

titlestringOptional

addressLine1stringOptional

addressLine2stringOptional

citystringOptional

districtstringOptional

postalCodestringOptional

phonestringOptional

get/v1/locations/{locationId}

GET /v1/locations/{locationId} HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Accept: */*

200

200 response

{
  "id": "text",
  "title": "text",
  "addressLine1": "text",
  "addressLine2": "text",
  "city": "text",
  "district": "text",
  "postalCode": "text",
  "phone": "text"
}