---
title: "Get Locations"
method: GET
path: "/customers/locations"
tags: ["Location"]
---

# Get Locations

`GET /customers/locations`

Get a list of Locations.

## Query parameters

- `page` integer
- `page_size` integer

## Headers

- `x-api-key` string, required

## Response `200`

Locations for the given customer

- ResponseLocations
  - `locations` LocationsResponse[]
    - `id` integer — Id
    - `name` string — Name
    - `street_address_1` string — Street Address 1
    - `street_address_2` string — Street Address 2
    - `city` string — City
    - `state_id` integer — State Id
    - `state` string — State Name
    - `zip_code` string — ZipCode
    - `country_id` integer — CountryId
    - `country` string — Country Name
    - `province` string — Province
    - `website` string — Website of the location
    - `phone_number` string — PhoneNumber
    - `email` string — Email
    - `show_in_wodifind` boolean — Show In WodiFind
    - `wodifind_name` string — WodiFind Name
    - `wodifind_description` string — WodiFind Description
    - `email_signature` string — Email Signature
    - `enable_email_signature` boolean — Enable Email Signature
    - `email_from_label` string — Email From Label
    - `staff_signature` string — This is the staff signature
    - `abn_number` string — The Australian business number used at this location. (Only applicable for Australian locations).
    - `gst_number` string — The GST Number used at this location. (Only applicable for New Zealand locations).
    - `business_type_id` integer — Identifies the business type for which the location belongs to
    - `customer_id` integer — Customer Id
    - `stripe_terminal_location_id` string — Stripe Terminal Location Id
    - `time_zone_id` integer — TimeZoneId
    - `time_zone` string — Time Zone
    - `time_zone_iana` string — Time zone in IANA format
    - `formatted_address` string — Formatted address
    - `location_latitude` number — latitude of location
    - `location_longitude` number — longitude of location
    - `lead_owner_id` integer — User Id of employee assigned as lead owner
    - `lead_owner` string — Name of employee assigned as Lead Owner
    - `client_owner_id` integer — User Id of employee Assigned as Client owner
    - `client_owner` string — Name of employee assigned as Client Owner
    - `created` Created — Record creation data.
      - `created_by_id` integer — Unique ID of the user that created the record.
      - `created_by` string — Name of the user that created the record.
      - `created_on_datetime` string, date-time — Datetime on which the record was created.
    - `updated` Updated — Update info
      - `updated_by_id` integer — Unique ID of the user that last updated the record.
      - `updated_by` string — Name of the user that most recently updated the record.
      - `updated_on_datetime` string, date-time — Datetime on which the record was last updated.
  - `pagination` Pagination — Pagination for API method responses.
    - `page` integer, required — Current page number.
    - `page_size` integer, required — Number of records per page.
    - `has_more` boolean, required — True if more records exist beyond the current page.
  - `wodify_validation_result` string — The purpose of this attribute is to save any UserException message, that is, and user friendly message that should be shown to the end user. All methods should have, just like service actions: - an UserException with Abort Transaction = Yes, and a Log Error = No - an AllExceptions with Abort Transaction = Yes, and a Log Error = Yes With this, any known issue that we don't consider an error log, like a business validation, we raise it to be catch in the UserException and we don't log it. Then, in the OnResponse of the full REST service, the Build_Response_JSON action will take care on the output json format. An Exception will have the default formatted error message. If its an AllException, it will log the error so that we can fix it. If its a UserException, it will deliver as an error but it won't log it as an error. A success output will not have this attribute, the Build_Response_JSON will remove it from the final output.

---

[API](https://skmtc.net/wodify/apis/leads.md) · [All operations](https://skmtc.net/wodify/apis/leads/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wodify/leads/revisions/974500ca0714/schema)