---
title: "Find addresses"
method: POST
path: "/user/addresses/lookup/find"
tags: ["user-addresses"]
---

# Find addresses

`POST /user/addresses/lookup/find`

Search for address suggestions from a free-text query.

Use this endpoint as step 1 in an assisted address-entry flow.

Request guidance:

- Provide a user-entered text value such as postcode, street name, or partial address.
- Provide container when refining from a previous response.
- Include a valid bearer token; this is an authenticated user endpoint.

Recommended flow:

1. Call POST /user/addresses/lookup/find with text from the user input.
2. If container-type results are returned, call this endpoint again with container to drill down.
3. When an address result is selected, call POST /user/addresses/lookup/retrieve with its id.
4. Persist the final address with POST /user/addresses.

Behavior notes:

- Returns suggestions only; no address is saved to the account.
- Responses may include both final addresses and intermediate container nodes.
- Empty results are valid and should be handled in UI as "no matching addresses found".

## Request body

- object
  - `text` string, required — The search term provided by the user
  - `container` string — The ID of a container to refine the search
  - `limit` number — The maximum number of results to return

## Response `200`

Find a list of addresses, or containers to refine the user's search

- object[]
  - `id` string, required — The ID of the location, use this to retrieve the full address
  - `description` string, required — A description of the location or "container"
  - `type` union, required — The type of location, e.g. "Address", "Postcode", etc.
    - 'Container'
    - 'Address'
    - 'Postcode'
    - 'Residential'
    - 'Street'
  - `text` string, required — The text matching the provided search
  - `highlight` string, required — A comma-separated list of highlighted indices in the text, ie. 0-2,3-9

---

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