Exploring the Graviti api
Get api v1 organizations by id
Get the organization details by using the organization id
GET/API/V1/ORGANIZATIONS/{ID}
Get The Organization Details By Organization ID
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
{
"chapters": [
{
"id": "string",
"name": "string",
"organizationId": "string",
"managedByFirstName": "string",
"managedByLastName": "string",
"managedByMiddleName": "string",
"contactPersonMiddleName": "string",
"contactNumber": "string",
"contactEmail": "string",
"city": "string",
"region": "string",
"countryId": "string",
"managingPersonTitleId": 0,
"created": "2023-12-08T08:33:25.063Z",
"updated": "2023-12-08T08:33:25.063Z",
"user": "string",
"contactPersonFirstName": "string",
"contactPersonLastName": "string",
"organization": "string",
"country": "string",
"managingTitle": "string",
"members": 0
}
],
"memberGroups": [
{
"id": "string",
"description": "string",
"organizationId": "string",
"user": "string",
"membersCount": 0,
"created": "2023-12-08T08:33:25.063Z",
"updated": "2023-12-08T08:33:25.063Z"
}
],
"organizationPaymentProviders": [
{
"baseUrl": "string",
"confirmationEmailAddress": "string",
"displayText": "string",
"id": "string",
"isActive": true,
"active": "string",
"isSystemDefault": true,
"systemDefault": "string",
"paymentProvider": "string",
"merchantId": "string",
"merchantKey": "string",
"merchantPassPhrase": "string",
"organizationId": "string",
"paymentNotifyUrl": "string",
"paymentProcessingUrl": "string",
"paymentProviderId": 0
}
],
"documentTypes": [
{
"created": "2023-12-08T08:33:25.063Z",
"description": "string",
"id": "string",
"user": "string",
"organizationId": "string",
"updated": "2023-12-08T08:33:25.063Z",
"documentsCount": 0
}
],
"organizationFeatures": [
{
"id": "string",
"organizationId": "string",
"featureId": "string",
"customLabel": "string",
"controller": "string",
"icon": "string",
"hasSubmenu": true,
"hasLink": true,
"link": "string",
"displayorder": 0,
"created": "2023-12-08T08:33:25.063Z",
"updated": "2023-12-08T08:33:25.063Z"
}
],
"organizationLabels": [
{
"id": "string",
"systemLabelId": "string",
"organizationId": "string",
"created": "2023-12-08T08:33:25.063Z",
"updated": "2023-12-08T08:33:25.063Z",
"user": "string",
"defaultName": "string",
"customName": "string"
}
],
"accountId": "string",
"contactName": "string",
"created": "2023-12-08T08:33:25.063Z",
"email": "string",
"id": "string",
"logo": "string",
"members": 0,
"name": "string",
"registrationNumber": "string",
"telephone": "string",
"updated": "2023-12-08T08:33:25.063Z",
"vatNumber": "string",
"website": "string"
}
Field |
Type |
Description |
Id |
String |
Internal id to identify the organization |
Name |
String |
Name of the organization |
Organization id |
String |
Organization id number |
Managed by first name |
String |
Name of the person managing the organization |
Managed by last name |
String |
Last name of the person managing the organization |
Managed by middle name |
String |
Middle name of the person managing the organization |
Contact personal middle name |
String |
Middle name of the contact person managing the organization |
Contact number |
String |
Contact number of the person managing the organization |
Contact email |
String |
Contact email of the person managing the organization |
City |
String |
City where the organization is located |
Region |
String |
Region where the organization is located |
Country id |
String |
Country id where the organization is located |
Managing person title id |
Integer |
Managing person title id |
Created |
Datetime |
Datetime when the organization was created in the system |
Updated |
Datetime |
Datetime when the organization was last updated. |
User |
String |
Name of the user |
Contact person first name |
String |
Contact person first name |
Contact person last name |
String |
Contact person last name |
Organization |
String |
Name of the organization |
Country |
String |
Name of the country |
Managing title |
String |
Managing title |
Members |
Integer |
Members within the organization |
Related topics