Back to resources

Exploring the Graviti api

Get api v1 members notes by id

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


GET/Api/V1/Members/Notes/{Id}

Get a record of a member’s notes record by note 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

{
  "id": "string",
  "note": "string",
  "memberOrganizationId": "string",
  "author": "string",
  "tags": "string",
  "user": "string",
  "isActive": true,
  "created": "2023-12-08T07:47:17.372Z",
  "updated": "2023-12-08T07:47:17.372Z"
}

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