# List locations

```
GET https://api.bookkeep.com/v1/entities/:entity_id/locations
```

The Location object represents a sales tax location. Locations are identified by a unique ID.

## Request

### Path Parameters

**entity_id** string required

entity_id

## Responses

- 200
- 401
- 404

A dictionary with a data property that contains an array of objects. Each entry in the array is a separate location object. If no more locations are available, the resulting array will be empty.

- application/json

- Schema
- Example (auto)

**Schema**  
**object** string  
**Default value:** `list`  
**Example:** `list`

**total_records** integer  
**Example:** `1`

**data** object[]  
Array [  
    **id** string  
    Unique identifier for the Location object.  
    **Example:** `nGBr7Vr7mNqW`  
    **entity_id** string  
    Unique identifier for the Entity object.  
    **Example:** `9zOe70LNPwlN`  
    **name** string  
    Name of Location.  
    **Example:** `JT Bottle Shop`  
    **address1** string  
    Address line 1.  
    **Example:** `61707 29 Palms Hwy`  
    **address2** string nullable  
    Address line 2.  
    **Example:** `string`  
    **city** string  
    City.  
    **Example:** `Joshua Tree`  
    **state** string  
    State.  
    **Example:** `CA`  
    **postal_code** string  
    Postal code.  
    **Example:** `92252`  
    **phone_number** string  
    Phone number.  
    **Example:** `+1917xxxxx00`  
    **email** string  
    Email address.  
    **Example:** `jason@bookkeep.co`  
    **headquarters** boolean  
    Indicates if this is the headquarters location.  
    **Example:** `true`  
    **end_of_day** string  
    Time of day that the business closes.  
    **Example:** `00:00`  
    **timezone** string  
    Timezone.  
    **Example:** `Pacific Time (US & Canada)`  
    **updated_at** string<date-time>  
    **Example:** `2023-05-23T07:57:26.851Z`  
    **closeout_offset** integer  
    Defaults to 0, minutes after midnight in the timezone of this address the location considers its end of day.
    **Example:** `0`
]

```json
{
  "object": "list",
  "total_records": 1,
  "data": [
    {
      "id": "nGBr7Vr7mNqW",
      "entity_id": "9zOe70LNPwlN",
      "name": "JT Bottle Shop",
      "address1": "61707 29 Palms Hwy",
      "address2": "string",
      "city": "Joshua Tree",
      "state": "CA",
      "postal_code": 92252,
      "phone_number": "+1917xxxxx00",
      "email": "jason@bookkeep.co",
      "headquarters": true,
      "end_of_day": "00:00",
      "timezone": "Pacific Time (US & Canada)",
      "updated_at": "2023-05-23T07:57:26.851Z",
      "closeout_offset": 0
    }
  ]
}
```

Returns an error if an invalid entity identifier was provided.

- application/json

- Schema
- Example (auto)

**Schema**  
**error** object

**message** string  
**Example:** `Couldn't find Organization`

**type** string  
**Example:** `invalid_request_error`

**status** string  
**Example:** `ok`

```json
{
  "error": {
    "message": "Couldn't find Organization",
    "type": "invalid_request_error",
    "status": "ok"
  }
}
```