Addresses

Get a saved address by ID

Retrieve an existing PurpleGrain address using its address ID, not a Google place ID. Returns its street number, route, city, subdivision, country and Google place ID. Use include to expand the city or location coordinates. This lookup does not change data.

get/addresses/{id}

Request

  • Base URL: https://api.purplegrain.com/api/v1
  • URL: https://api.purplegrain.com/api/v1/addresses/{id}
  • Auth: none declared

Path parameters

idstring required

ID of an existing PurpleGrain address.

Query parameters

includestring
Example:city.location

Comma-separated snake_case relationship paths to embed (JSON:API included array, or inlined for application/json). Never embedded by default; unknown paths ignored; dot notation selects children; max 10 paths. Allowed paths: city, city.location, location.

Response

Successful. When the include query parameter is used, the response may contain an included array (JSON:API) or inlined related resources (application/json).

Example response

{
  "data": {
    "type": "address"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.