Back to resources

Exploring the Graviti api

Get api v1 members addresses by id

Get address records of members using the address record id that is available on the administration portal


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

Get a record of a member’s address record by address record ID that is available on the administration portal

REQUEST INFORMATION

Parameters

Name

Type

Additional information

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

{
  "addressLine1": "string",
  "addressLine2": "string",
  "addressLine3": "string",
  "addressLine4": "string",
  "addressType": "string",
  "addressTypeId": 0,
  "code": "string",
  "created": "2023-12-08T07:37:56.574Z",
  "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-08T07:37:56.574Z"
}

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



Related topics