Back to resources

Exploring the Graviti api

Get api v1 members notes by members id

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


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

Get a list of the notes records of a member by member record ID.

REQUEST INFORMATION

Parameters

Name

Type

Additional information

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": [
    {
      "id": "string",
      "note": "string",
      "memberOrganizationId": "string",
      "author": "string",
      "tags": "string",
      "user": "string",
      "isActive": true,
      "created": "2023-12-08T08:19:56.909Z",
      "updated": "2023-12-08T08:19:56.909Z"
    }
  ],
  "totalPages": 0,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "nextPageNumber": 0,
  "previousPageNumber": 0
}

Field

Type

Description

Id

String

Member notes id to identify the notes

Note

String

The note content

Member organization id

String

Member organization id to identify the member

Author

String

Note author

Tags

String

Note tags

User

String

Note user

Is active

Boolean

Indication whether the note is active or not

Created

Datetime

Datetime when the member note record was created in the system

Updated

Datetime

Datetime when the member note record was last updated.



Related topics