Exploring the Graviti api
Get api v1 organizations labels by organizations id
Get a list of the labels within the organization by using organization id
GET/api/v1/Organizations/{id}/labels
Get a list of the labels 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": [
{
"id": "string",
"systemLabelId": "string",
"organizationId": "string",
"created": "2023-12-08T09:04:58.453Z",
"updated": "2023-12-08T09:04:58.453Z",
"user": "string",
"defaultName": "string",
"customName": "string"
}
],
"totalPages": 0,
"hasPreviousPage": true,
"hasNextPage": true,
"nextPageNumber": 0,
"previousPageNumber": 0
}
Field |
Type |
Description |
Id |
String |
Internal id to identify the document type |
System label id |
String |
Internal id to identify the system label |
Organization id |
String |
Organization id number |
Created |
Datetime |
Datetime when the label was created in the system |
Updated |
Datetime |
Datetime when the label was last updated. |
User |
String |
Name of the user |
Custom name |
String |
The custom name of the label |
Related topics