Back to resources

Exploring the Graviti api

Get api v1 members docs by members id

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


GET/API/V1/MEMBERS/{ID}/DOCS

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

REQUEST INFORMATION

Parameters

Name

Type

Additional information

Member 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": [
    {
      "created": "2023-12-08T08:05:35.367Z",
      "documentUrl": "string",
      "title": "string",
      "id": "string",
      "member": "string",
      "memberId": "string",
      "memberOrganizationId": "string",
      "organizationId": "string",
      "documentType": "string",
      "documentTypeId": "string",
      "updated": "2023-12-08T08:05:35.367Z",
      "uploadedBy": "string"
    }
  ],
  "totalPages": 0,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "nextPageNumber": 0,
  "previousPageNumber": 0
}

Field

Type

Description

Created

Datetime

Datetime when the member document record was created in the system

Document url

String

Member document link

Title

String

Member document title

Id

String

Document id to identify the document

Member

String

Name of the member

Member id

String

Member id to identify the member

Member organization id

String

Member organization id to identify the member

Organization id

String

Id to identify the organization

Document type

String

Member document type

Document type id

String

Document type id to identify the document

Updated

Datetime

Datetime when the member document record was last updated.

Uploaded by

String

Name of the person who uploaded the record



Related topics