# Retrieve an address book entry

`GET https://api.mothership.com/beta/address-book/{addressId}`

Sandbox: `https://sandbox.api.mothership.com/beta/address-book/{addressId}`

This endpoint gets the address book entry represented by addressId.

## Authorization

Send your API token as a Bearer token: `Authorization: Bearer <token>`.

## Path parameters

- `addressId` (string<uuid>, required): ID of the address book entry.

## Responses

### 200

The entry, wrapped inside an object named "data"

- `data` (object, required)
  - `id` (string<uuid>, required): ID of the address book entry.
  - `nickname` (string, required, nullable): Your own name for this location.
  - `companyName` (string, required, nullable): Business or company name at this location.
  - `address` (object, required)
    - `street` (string, required): Street address.
    - `subStreet` (string, required, nullable): Substreet of the address, such as suite number or letter.
    - `city` (string, required): City.
    - `state` (string, required): 2-letter uppercase state abbreviation of the address.
    - `zip` (string, required): ZIP code.
  - `formattedAddress` (string, required): The full address on one line.
  - `openTime` (string, required, 4 characters, pattern ^[0-9]{4}$, nullable): Open time of this location, in 4-digit 24-hour time format (HHmm) of this location's timezone. For example: 0900 to represent 9:00am in local time.
  - `closeTime` (string, required, 4 characters, pattern ^[0-9]{4}$, nullable): Close time of this location, in 4-digit 24-hour time format (HHmm) of this location's timezone. Must be later than openTime. For example: 1700 to represent 5:00pm in local time.
  - `pickup` (object, required)
    - `contactName` (string, required, nullable): Full name of the contact at this location.
    - `phoneNumber` (string, required, nullable): Contact's US phone number in E.164 format For example: +17148130000.
    - `phoneExtension` (string, required, nullable): Contact's phone extension, up to 10 digits.
    - `email` (string, required, nullable): Contact's email.
    - `notes` (string, required, nullable): Instructions for the driver at this location.
    - `accessorials` (array of strings, required): Accessorials required at this location. notifyBeforeArrival is delivery only, and only for users it is enabled for, as on quotes. A service saved on the dashboard that this API has no name for comes back as stored, such as white-glove-delivery. On update, the list replaces the saved one but keeps those services, so leave them out of the list you send.
  - `delivery` (object, required)
    - `contactName` (string, required, nullable): Full name of the contact at this location.
    - `phoneNumber` (string, required, nullable): Contact's US phone number in E.164 format For example: +17148130000.
    - `phoneExtension` (string, required, nullable): Contact's phone extension, up to 10 digits.
    - `email` (string, required, nullable): Contact's email.
    - `notes` (string, required, nullable): Instructions for the driver at this location.
    - `accessorials` (array of strings, required): Accessorials required at this location. notifyBeforeArrival is delivery only, and only for users it is enabled for, as on quotes. A service saved on the dashboard that this API has no name for comes back as stored, such as white-glove-delivery. On update, the list replaces the saved one but keeps those services, so leave them out of the list you send.
  - `createdAt` (string<date-time>, required): ISO string of when the entry was created.
  - `updatedAt` (string<date-time>, required): ISO string of when the entry was last changed.

### 404

No address book entry with the given id exists for the caller organization

- `code` (number, required) One of: `100`, `101`, `200`, `201`, `202`, `203`, `204`, `205`, `206`, `300`, `301`, `302`, `303`, `304`, `305`, `307`, `400`, `401`, `402`, `403`, `404`, `405`, `406`, `407`, `408`, `409`, `410`, `411`, `412`, `413`, `414`, `415`, `416`, `417`, `422`, `429`, `500`, `501`, `502`, `503`, `504`, `505`.
- `type` (string, required) One of: `UNKNOWN`, `NOT_FOUND`, `SERVER_ERROR`, `UNAUTHENTICATED`, `MISSING_PERMISSION`, `INVALID_REQUEST`, `RATE_LIMIT_EXCEEDED`, `CARGO_TOO_LARGE`, `NO_RATES_FOUND`, `QUOTE_NOT_PURCHASABLE`, `PAYMENT_REQUIRED`, `PAYMENT_FAILED`.
- `message` (string, required)
- `metadata` (object, optional)

## Example request

```bash
curl --request GET \
  --url 'https://sandbox.api.mothership.com/beta/address-book/addressId' \
  --header "Authorization: Bearer $MOTHERSHIP_API_TOKEN" \
  --header 'Accept: application/json'
```

## Example response (200)

```json
{
  "data": {
    "id": "3f1c2a9e-5b7d-4e8a-9c61-2d4f8b0e7a15",
    "nickname": "string",
    "companyName": "Chemtrec",
    "address": {
      "street": "2800 E Observatory Rd",
      "subStreet": "string",
      "city": "Los Angeles",
      "state": "CA",
      "zip": "90027"
    },
    "formattedAddress": "string",
    "openTime": "0900",
    "closeTime": "1700",
    "pickup": {
      "contactName": "string",
      "phoneNumber": "+15555555555",
      "phoneExtension": "string",
      "email": "logistics@example.com",
      "notes": "Dock door 3",
      "accessorials": [
        "string"
      ]
    },
    "delivery": {
      "contactName": "string",
      "phoneNumber": "+15555555555",
      "phoneExtension": "string",
      "email": "logistics@example.com",
      "notes": "Dock door 3",
      "accessorials": [
        "string"
      ]
    },
    "createdAt": "2026-03-19T17:00:00.000Z",
    "updatedAt": "2026-03-19T17:00:00.000Z"
  }
}
```