Back to resources

Exploring the Graviti api

Get api v1 members contacts by members id

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


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

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

REQUEST INFORMATION

Parameters

Name

Type

Additional information

Contact 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": [
    {
      "contactType": "string",
      "contactTypeId": 0,
      "created": "2023-12-08T08:12:56.430Z",
      "id": "string",
      "member": "string",
      "memberId": "string",
      "organization": "string",
      "organizationId": "string",
      "memberOrganizationId": "string",
      "updated": "2023-12-08T08:12:56.430Z",
      "value": "string",
      "usageTypeId": 0,
      "usageType": "string"
    }
  ],
  "totalPages": 0,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "nextPageNumber": 0,
  "previousPageNumber": 0
}

Field

Type

Description

Contact type

String

Contact type of the member contact

Contact type id

Integer

Contact type Id of the contact type

Created

Datetime

Datetime when the member contact record was created in the system

Id

String

Internal ID to identify member contacts

Member

String

The 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

Updated

Datetime

Datetime when the member contact record was last updated.

Value

String

The value of the contact

Usage type id

Integer

The contact usage type id

Usage type

String

The contact usage type



Related topics