Back to resources

Exploring the Graviti api

Get api v1 organizations document types by organizations id

Get a list of the document types within the organization by using organization id


GET/api/v1/Organizations/{id}/documentTypes

Get a list of the document types within the organization, by organization 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": [
    {
      "created": "2023-12-08T08:52:57.440Z",
      "description": "string",
      "id": "string",
      "user": "string",
      "organizationId": "string",
      "updated": "2023-12-08T08:52:57.440Z",
      "documentsCount": 0
    }
  ],
  "totalPages": 0,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "nextPageNumber": 0,
  "previousPageNumber": 0
}

Field

Type

Description

Created

Datetime

Datetime when the document type was created in the system

Description

String

Description of the group

Id

String

Internal id to identify the document type

User

String

Name of the user

Organization id

String

Organization id number

Updated

Datetime

Datetime when the organization was last updated.

Documents count

Integer

Documents  within the document type



Related topics