---
title: "Get all addresses"
method: GET
path: "/public/v2/addresses"
tags: ["Addresses"]
---

# Get all addresses

`GET /public/v2/addresses`

Required permission: Account information, View.<br/>Returns all addresses on the account in paginated form.

## Query parameters

- `addressIds` string[]
- `metadata` string
- `page` integer

## Response `200`

Addresses retrieved

- AddressResponsePaginatedServiceResponse
  - `errors` ValidationResult[], nullable
    - `memberNames` string[], nullable
    - `errorMessage` string, nullable
  - `warnings` ValidationResult[], nullable
    - `memberNames` string[], nullable
    - `errorMessage` string, nullable
  - `information` string[], nullable
  - `isValid` boolean
  - `content` AddressResponsePaginated
    - `pageIndex` integer
    - `limit` integer
    - `isLastPage` boolean
    - `results` AddressResponse[], nullable
      - `addressReferenceId` string, uuid — Reference identifier for address. Example: 55ec6574-10d8-bd9c-1951-d4184f4ae467
      - `addressLines` string[] — The address lines for the address. Example: 1 Rocket Road
      - `locality` string, nullable — The town/locality of the address. Example: Hawthorne
      - `administrativeArea` string, nullable — The administrative area of the address. Example: California
      - `administrativeAreaCode` string — The administrative area code of the address. Example: CA
      - `region` string, nullable — The region of the address. Example: United States
      - `regionCode` string — The region code of the address. Example: US
      - `postalCode` string — The postal code of the address. Example: 90250
      - `metadata` string, nullable — Optional field that can be used to store information about the address for external purposes
      - `formattedAddress` string — A user readable address. Example: 1 Rocket Road, Hawthorne, CA 90250-6844, US
      - `latitude` number, double — The latitude of the address: Example 33.92
      - `longitude` number, double — The longitude of the address. Example: -118.32
    - `totalCount` integer

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Missing required permission for this endpoint or resource
- `422` — Failed to retrieve addresses

---

[API](https://skmtc.net/starlink/apis/starlink-management-api.md) · [All operations](https://skmtc.net/starlink/apis/starlink-management-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/starlink/starlink-management-api/revisions/a730bd0ddb42/schema)