Get api v1 members addresses by members id

Get member address records by using member id that is available on the administration portal

GET/api/v1/Members/{id}/addresses

Get a list of the address records of a member, by member record ID.

REQUEST INFORMATION

Parameters

Name	Type	Additional information
Address Type Id	Integer
Key	String
Entity Id	String
Page Size	Integer
Page	Integer
Id	String	Required
x-api-key	Header	Required
x-api-secret	Header	Required

 

RESPONSE INFORMATION

• Code: 200
• Description: successful
• Media type: text/plain; application/json; text/json
• Links: no links

Example value|Schema

{
  "totalItems": 0,
  "pageNumber": 0,
  "pageSize": 0,
  "data": [
    {
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "addressLine4": "string",
      "addressType": "string",
      "addressTypeId": 0,
      "code": "string",
      "created": "2023-12-08T08:15:27.726Z",
      "id": "string",
      "member": "string",
      "memberId": "string",
      "organization": "string",
      "organizationId": "string",
      "memberOrganizationId": "string",
      "countryId": "string",
      "country": "string",
      "region": "string",
      "usageTypeId": 0,
      "usageType": "string",
      "updated": "2023-12-08T08:15:27.726Z"
    }
  ],
  "totalPages": 0,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "nextPageNumber": 0,
  "previousPageNumber": 0
}

Field	Type	Description
Address line 1	String	Complex name
Address line 2	String	Street address
Address line 3	String	Suburb
Address line 4	String	Town or city
Address type	String	Address type
Address line type id	Integer	address line type id
Code	String	Address code
Created	Datetime	Datetime when the member address record was created in the system
Id	String	Address id to identify the address
Member	String	Name of the member
Member id	String	The member id number to identify the member
Organization	String	The name of the organization the member belongs to
Organization id	String	The organization id number to identify the organization
Member organization id	String	Member organization id to identify the member
Country id	String	Country id to identify the country
Country	String	Name of the country
Region	String	Region in the country
Usage type id	Integer	Usage type id to identify the address
Usage type	String	Usage type of the address
Updated	Datetime	Datetime when the member address record was last updated.

---

---

Related topics

• Get Api V1 Members By Id

---