Skip to main content
POST
/
user
/
addresses
/
lookup
/
find
curl --request POST \
  --url https://api.managem.co.uk/user/addresses/lookup/find \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": "34 Selborne Cl"
}
'
[
  {
    "id": "GB|RM|A|10321882|ENG",
    "description": "Petersfield GU32 2JB",
    "type": "Address",
    "text": "34 Selborne Close",
    "highlight": "0-2,3-11,12-14"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
text
string
required

The search term provided by the user

Example:

"55 Walnut tr"

​
container
string

The ID of a container to refine the search

Example:

"GB|RM|A|10321882|ENG"

​
limit
number
default:10

The maximum number of results to return

Required range: 1 <= x <= 20

Response

200 - application/json

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

​
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
required

The type of location, e.g. "Address", "Postcode", etc.

Available options:
Container
​
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