Command Palette

Search for a command to run...

Log In
Get help

List Addresses for a Participant

get/public/v1/participants/{participant}/addresses

Authorization

  • Authorizationstringrequired

    Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

Path parameters

  • participantstringrequired

    The participant UUID

Query parameters

  • filter[type]string

    Filter by address type. Comma-separate to combine values. One of: primary, postal, other.

    Example:primary
  • page[size]integer

    Number of results per page. Minimum 1, maximum 100.

    Default:25
  • page[number]integer

    The page number to retrieve. Use the last_page value from the meta response to determine the total number of pages available.

    Default:1

Response

200application/json

Paginated set of ParticipantAddressResource

  • dataobject[]required
    ▶Show 15 child attributes
    • idstringrequired
      Example:a1d2d3r4-e5s6-47s8-9a0b-1c2d3e4f5a6b
    • typestring | nullrequired

      A replaced primary address is kept as other, so filter on this rather than assuming one row per type.

      Example:primary
    • labelstring | nullrequired
      Example:Previous Primary Address
    • address_1stringrequired
      Example:12 Harbour View Drive
    • address_2string | nullrequired
      Example:Unit 4
    • address_3string | nullrequired
      Example:Building B
    • suburbstring | nullrequired
      Example:Lavender Bay
    • statestringrequired
      Example:NSW
    • postcodestringrequired
      Example:2060
    • countrystringrequired
      Example:Australia
    • latstring | nullrequired
      Example:-33.8447
    • lngstring | nullrequired
      Example:151.2094
    • traditional_place_namestring | nullrequired
      Example:Gadigal Country
    • detailsstring | nullrequired
      Example:Enter via the side gate
    • formattedstringrequired
      Example:Gadigal Country, 12 Harbour View Drive, Unit 4, Building B, Lavender Bay, NSW, 2060
  • metaobjectrequired
    ▶Show 5 child attributes
    • current_pageintegerrequired≥ 1
    • last_pageintegerrequired≥ 1
    • per_pageintegerrequired≥ 0

      Number of items shown per page.

    • totalintegerrequired≥ 0

      Total number of items being paginated.

    • allowed_sortsstring[]required

      The list of allowed sorts for this endpoint.

Errors

  • 401Unauthenticated
  • 403Authorization error
  • 404Not found