Introduction
Welcome to the documentation of WorkDrive API Access. You can use our API to access endpoints of various modules, which can perform several CRUD operations.
We have shown example schemas of each API in this docs! You can view code examples in the dark area to the right, and you can switch the tabs in the top right to view Request and Response body of each API.
Authentication
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
To access any API you first need to authorize yourself by following the steps shown below:
1: Login to your WorkDrive account.
2: Click on your profile picture shown on the top right of your screen > Click Manage
3: Scroll to the left until you see the 3 upside down dots against any user record. Click this icon and Select Api Access
4: Regenrate new API access token and use this to get authorize yourself to the API Access endpoints.
5: Use the API Access Token as a Header key "X-API-KEY" value to access any API.
User
Welcome to the User API! You can use our API to access User listing, Update Users and to On-board a new User.
Get All Users
In this section you can find the APIs that are use to get the information of all users of a specific Organization that can be filtered on the basis of Users Department and Locations and to Update any user information.
HTTP Request
GET https://[[API_SERVER_ENDPOINT]]/api/users
Query Parameters
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"cur_page":1,
"per_page":5,
"department":"1ae6eb71-dddf-48b7-945f-78127fd85801",
"location":"e9659111-c52a-42c9-b6ed-42d0f5bdd29e"
}
{
"users": [
{
"id": "string",
"createdAt": "2022-12-22T09:09:12.831Z",
"updatedAt": "2022-12-22T09:09:12.831Z",
"createdBy": "string",
"updatedBy": "string",
"orgId": "string",
"userName": "string",
"email": "john@example.com",
"status": "string",
"firstName": "John",
"lastName": "Smith",
"picture": {},
"cover": {},
"bio": "string",
"phone": "string",
"reportsTo": "string",
"designation": "string",
"department": "string",
"isDepartmentHead": true,
"color": "string",
"isExpert": true,
"availability": 1,
"location": {},
"reportsToObj": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"departmentData": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
}
],
"meta": {
"perPage": 0,
"totalPages": 0,
"totalResults": 0,
"curPage": 0,
"nextPage": 0
}
}
| Parameter | Type | Default | Description |
|---|---|---|---|
| cur_page | integer | 1 | A page number within the paginated result set. |
| per_page | integer | 10 | Number of results to return per page. |
| location | uuid | - | Filter Users by specifying the location id. You can find the list of locations by using the Location listing API. |
| department | uuid | - | Filter Users by specifying the department id. You can find the list of departments by using the Department listing API. |
Get All Team Supervisors
Through this API you can get the list of the supervisors that have certain reportees
HTTP Request
GET https://[[API_SERVER_ENDPOINT]]/api/users/supervisors
Query Parameters
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"cur_page":1,
"per_page":5,
"userId" : '90a34cdd-cb83-49b5-9b54-fe1dd2d829ff'
}
{
"users": [
{
"id": "string",
"email": "john@example.com",
"firstName": "John",
"lastName": "Smith"
}
],
"meta": {
"perPage": 0,
"totalPages": 0,
"totalResults": 0,
"curPage": 0,
"nextPage": 0
}
}
| Parameter | Type | Default | Description |
|---|---|---|---|
| cur_page | integer | 1 | A page number within the paginated result set. |
| per_page | integer | 10 | Number of results to return per page. |
| userId | uuid | - | Id of the user corresponding to which supervisor listing will fetch. |
Create a User
Through this API you can create a new User.
HTTP Request
POST https://[[API_SERVER_ENDPOINT]]/api/users/add
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| bulk | boolean | An optional parameter that will allow you to get the missing user detail from the default user on-boarding settings and create a user |
Request Body
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"email": "string",
"phone": "string",
"firstName": "John",
"lastName": "Smith",
"designation": "Manager",
"isDepartmentHead": true,
"department": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"location": "string",
"securityGroup": "string",
"reportsTo": "string",
"skill": [
"string"
],
"defaultVisibility": "string",
"addAdditionalTeams": [
"string"
]
}
{
"id": "string",
"createdAt": "2022-12-21T10:57:54.722Z",
"updatedAt": "2022-12-21T10:57:54.722Z",
"createdBy": "string",
"updatedBy": "string",
"orgId": "string",
"userName": "string",
"email": "john@example.com",
"status": "string",
"firstName": "John",
"lastName": "Smith",
"picture": 20,
"cover": {},
"bio": "string",
"phone": "string",
"reportsTo": "string",
"designation": "string",
"department": "string",
"isDepartmentHead": true,
"color": "string",
"isExpert": true,
"availability": 1,
"location": {},
"teamMembers": [
"string"
],
"userAdditionalTeams": [
"string"
],
"addAdditionalLocations": [
"string"
],
}
| Parameter | Type | Schema Values | Description |
|---|---|---|---|
| any | Email of the User. | ||
| phone | string | any | Phone number of the user. |
| firstName | string | any | First name of the User. |
| lastName | string | any | Last name of the User. |
| designation | string | any | Job Title of the User. |
| isDepartmentHead | boolean | true, false | Is the User a head of department or not. |
| department | uuid | any | Department Id to which the user belongs.You can find the list of departments by using the Department listing API. |
| location | uuid | any | Location Id of the User.You can find the list of locations by using the Location listing API. |
| securityGroup | uuid | any | securityGroup Id which should be assigned to User. List of Security Groups can get using Securtiy Group API |
| reportsTo | uuid | any | User's supervisor Id. You can get the list of Users through User Listing API. |
| skill | Array<String> | any | Skills of the user. |
| defaultVisibility | string | public, restricted | Visibilty type of the user. |
| addAdditionalTeams | Array<uuid> | any | Ids of the Team supervisors. Users can join several teams by specifying their supervisor Ids. List of the supervisor can get through Team Supervisor Listing. |
| addAdditionalLocations | Array<uuid> | any | Ids of the locations whose corresponding Location Admins will be assigned to the user's supervisors. You can get the list of locations from the Location listing API. |
Update a User
Through this API you can update the user's information.
HTTP Request
PATCH https://[[API_SERVER_ENDPOINT]]/api/users/{id}
Path Parameters
| Parameter | description |
|---|---|
| id | Id of the user that needs to be updated |
Request Body
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"firstName": "John",
"lastName": "Smith",
"status": "ARCHIVE",
"phone": "+13756366604",
"isExpert": false,
"availability": "ACTIVE",
"fileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"coverFileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reportsTo": "a0c3f96f-73c3-4c67-ba43-b94d640f2485",
"designation": "Web Developer",
"bio": "string",
"isDepartmentHead": false,
"department": "Development/Subdivider",
"location": "e9659111-c52a-42c9-b6ed-42d0f5bdd29e",
"addAdditionalTeams": [
"string"
],
"removeAdditionalTeams": [
"string"
]
}
{
"id": "string",
"createdAt": "2022-12-21T11:44:08.324Z",
"updatedAt": "2022-12-21T11:44:08.324Z",
"createdBy": "string",
"updatedBy": "string",
"orgId": "string",
"userName": "string",
"email": "john@example.com",
"status": "string",
"firstName": "John",
"lastName": "Smith",
"picture": 20,
"cover": {},
"bio": "string",
"phone": "string",
"reportsTo": "string",
"designation": "string",
"department": "string",
"isDepartmentHead": true,
"color": "string",
"isExpert": true,
"availability": 1,
"location": {},
"teamMembers": [
"string"
],
"badges": [
{
"id": "string",
"title": "string",
"description": "string",
"badgeFileName": "string",
"orgId": "string",
"path": "string"
}
],
"userAdditionalTeams": [
"string"
],
"addAdditionalLocations": [
"string"
]
}
| Parameter | Type | Schema Values | Description |
|---|---|---|---|
| firstName | string | any | First name of the User. |
| lastName | string | any | Last name of the User. |
| status | string | ACTIVE, ARCHIVE, PRE_INVITED, INVITED,BLOCKED | Filter Users by specifying the location. |
| phone | string | any | Phone number of the user. |
| isExpert | boolean | true, false | Is the User is an expert or not. |
| availability | string | ACTIVE, AWAY | Is the User available or not. |
| fileId | uuid | any | Media id of the user's profile picture. Upload a user profile picture through a media API |
| coverFileId | uuid | any | Media id of the user's cover picture. Upload a user cover photo using a media API |
| reportsTo | uuid | any | User's supervisor Id. |
| designation | string | any | Job Title of the User. |
| bio | string | any | Bio of the User. |
| isDepartmentHead | boolean | true, false | Is the User a head of department or not. |
| department | uuid | any | Department Id to which the user belongs.You can find the list of departments by using the Department listing API. |
| location | uuid | any | Location Id of the User.You can find the list of locations by using the Location listing API. |
| addAdditionalTeams | Array<uuid> | any | Ids of the Team supervisors. Users can join several teams by specifying their supervisor Ids. List of the supervisor can get through Team Supervisor Listing. |
| removeAdditionalTeams | Array<uuid> | any | Ids of the Team supervisors of which user have joined the teams. |
| addAdditionalLocations | Array<uuid> | any | Ids of the locations whose corresponding Location Admins will be assigned to the user's supervisors. You can get the list of locations from the Location listing API. |
Delete a User
Through this API you can delete any User.
HTTP Request
Delete https://[[API_SERVER_ENDPOINT]]/api/users/{id}
Path Parameters
| Parameter | description |
|---|---|
| id | Id of a User need to be deleted |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| bulk | boolean | An optional parameter that will allow you to get the data assignees of the deleted user from the default user off-boarding settings |
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
Bulk Create User
Through this API you can create multiple Users at once.
HTTP Request
POST https://[[API_SERVER_ENDPOINT]]/api/users/bulk-create
Request Body
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"data": [
{
"email": "string",
"phone": "string",
"firstName": "John",
"lastName": "Smith",
"designation": "Manager",
"isDepartmentHead": true,
"department": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"location": "string",
"securityGroup": "string",
"skill": [
"string"
],
"defaultVisibility": "string",
"externalUserId": "string",
"addAdditionalTeams": [
"string"
],
"addAdditionalLocations": [
"string"
],
"reportsTo": "string"
}
]
}
[{
"id": "string",
"createdAt": "2022-12-21T10:57:54.722Z",
"updatedAt": "2022-12-21T10:57:54.722Z",
"createdBy": "string",
"updatedBy": "string",
"orgId": "string",
"userName": "string",
"email": "john@example.com",
"status": "string",
"firstName": "John",
"lastName": "Smith",
"picture": 20,
"cover": {},
"bio": "string",
"phone": "string",
"reportsTo": "string",
"designation": "string",
"department": "string",
"isDepartmentHead": true,
"color": "string",
"isExpert": true,
"availability": 1,
"location": {},
"teamMembers": [
"string"
],
"userAdditionalTeams": [
"string"
],
"addAdditionalLocations": [
"string"
],
}]
Bulk Delete User
Through this API you can delete any User.
HTTP Request
Delete https://[[API_SERVER_ENDPOINT]]/api/users/bulk-delete
Request Body
{
"ids": [
"string"
]
}
| Parameter | Type | Description |
|---|---|---|
| id | Array<String> | Users id that need to be deleted |
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
Organization
In this section you can find the APIs that are use to create a new organization and update any organization.
Create a new Organization
Through this API you can create a new Organization.
HTTP Request
POST https://[[API_SERVER_ENDPOINT]]/api/organization
Request Body
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"name": "Stilla",
"admin": {
"firstName": "john",
"lastName": "smith",
"email": "abc@xyz.com"
},
"auth": {
"method": "internal"
}
}
{
"createdAt": "2023-03-03T06:44:27.486Z",
"updatedAt": null,
"id": "bd06213a-a26b-4cd7-a6b8-cfa154073e1f",
"status": "ACTIVE",
"subdomain": "stilla",
"parentOrgId": null,
"name": "Stilla",
"legalName": "Stilla",
"websites": null,
"address": null,
"email": null,
"phone": null,
"description": null,
"industry": null,
"authMethod": "internal",
"createdBy": "a3068d46-b993-11ed-afa1-0242ac120002",
"accessToken": "3fexxx-xxx-x-xxxxx-xxxx-xxxx-xxxxx"
}
| Parameter | Type | Nested Fields | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| name | string | - | Name of an organization. | ||||||||||||
| admin | Object |
|
|||||||||||||
| auth | Object |
|
Auth method to create an organization |
Update an Organization
Through this API you can update any organization.
HTTP Request
Patch https://[[API_SERVER_ENDPOINT]]/api/organization/{id}
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
Path Parameters
| Parameter | description |
|---|---|
| id | Id of an organization need to be updated |
{
"fileId": "38443974-b996-11ed-afa1-0242ac120002",
"name": "Stilla",
"legalName": "stilla",
"websites": [
"abc_stilla.com"
],
"address": {
"street1": "3739 Liberty Avenue",
"street2": null,
"city": "Anaheim",
"state": "California",
"zip": "92805"
},
"email": "stilla@abc.com",
"phone": "714-517-5291",
"description": "Real estate organization",
"industry": null
}
{
"createdAt": "2023-03-03T07:53:49.830Z",
"updatedAt": "2023-03-03T07:53:49.830Z",
"id": "string",
"status": "string",
"subdomain": "string",
"parentOrgId": "string",
"name": "string",
"legalName": "string",
"websites": [
"string"
],
"address": {
"street1": "string",
"street2": "string",
"city": "string",
"state": "string",
"zip": "string"
},
"file": {
"id": "string",
"mime": "string",
"path": "string",
"name": "string",
"processing": {},
"metadata": {},
"size": 0,
"url": "string",
"cdn": "string",
"bucket": "string",
"mp4Urls": [
"string"
],
"hlsUrl": "string",
"dashUrl": "string",
"thumbnail": "string",
"isImage": true,
"isVideo": true,
"isDoc": true,
"createdAt": "2023-03-03T07:53:49.830Z",
"owner": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"locationId": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com",
"externalUserId": "string"
}
},
"email": "abc@xyz.com",
"phone": "714-517-5291",
"description": "Real estate company",
"industry": "Real estate",
"authMethod": [
"internal"
]
}
| Parameter | Type | Schema Values | Nested Fields | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| fileId | uuid | any | - | Id of an organization media. Upload a media file using upload a media API | ||||||||||||
| name | string | any | - | Name of an organization. | ||||||||||||
| legalName | string | any | - | legal name of an organization. | ||||||||||||
| websites | Array |
any | - | Websites of an organization. | ||||||||||||
| address | Object | any |
|
|||||||||||||
| any | - | Email of the organization | ||||||||||||||
| phone | string | any | - | Contact number of the organization | ||||||||||||
| description | string | any | - | Description information of the organization | ||||||||||||
| industry | string | any | - | Industrial information related to the organization |
Access Token
In this section you can find the APIs that are use to an access token for the users.
Generate a new AccessToken
Through this API you can generate a new access token for the user.
HTTP Request
POST https://[[API_SERVER_ENDPOINT]]/api/token/generate-access
Request Body
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"userId": "bd06213a-a26b-4cd7-a6b8-cfa154073e1f"
}
{
"userId": "20cf22ed-be0b-40ce-930b-5aae73d2563c",
"token": "3080826c-1270-45c7-b40f-36ac317556fd"
}
| Parameter | Type | Nested Fields | Description |
|---|---|---|---|
| userId | uuid | Id of the user against which accessToken will be generated. You can get the list of users through User Listing API. |
Post
In this section you can find the APIs that are use to access Post listing, Create, Update and Delete a Post.
Get All Posts
Through this API you can get all the Posts of a User's Organization that can be filtered on the basis of different types.
HTTP Request
GET https://[[API_SERVER_ENDPOINT]]/api/posts
Query Parameters
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"time":"2022-10-17T09:21:41.247Z",
"per_page":"5",
"sort_key":"a"
}
{
"posts": [
{
"id": "string",
"postText": "string",
"postedAt": "2022-12-16T06:47:09.531Z",
"commentsCount": 0,
"user": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
},
"files": {
"id": "string",
"mime": "string",
"path": "string",
"name": "string",
"processing": {},
"metadata": {},
"size": 0,
"url": "string",
"cdn": "string",
"bucket": "string",
"mp4Urls": [
"string"
],
"hlsUrl": "string",
"dashUrl": "string",
"thumbnail": "string",
"isImage": true,
"isVideo": true,
"isDoc": true,
"createdAt": "2022-12-16T06:47:09.531Z",
"owner": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
},
"linkPreviews": {
"title": "string",
"description": "string",
"image": "string",
"link": "string"
},
"tags": [
"string"
],
"reactions": [
{}
],
"mentions": [
{
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
],
"taggedUsers": [
{
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
],
"gif": "string",
"links": [
"string"
],
"reactionUsers": [
{
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
],
"location": {
"textAddress": "string"
}
}
],
"meta": {
"perPage": 0,
"totalPages": 0,
"totalResults": 0,
"curPage": 0,
"nextPage": 0
}
}
| Parameter | Type | Default | Description |
|---|---|---|---|
| time* required | Time | Current Time | All the posts till the specified time. |
| per_page | integer | 10 | Number of results to return. |
| sort_key | string | - | Select specific option from list below.
|
Create a Post
Through this API you can create a new Post.
HTTP Request
POST https://[[API_SERVER_ENDPOINT]]/api/posts
Request Body
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"permissions": {
"users": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"groups": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"locations": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"public": true,
"friends": true,
"onlyMe": true,
"team": true
},
"tags": "#myfirstpost",
"mention": "6187fcb0-6151-11ec-9294-cfe91ad8177f",
"fileIds": [
"f5743644-c8ce-4bbe-a9bd-dfdd18dce445",
"1f1b75a3-f773-4fd6-a63e-9a5fb978b21e"
],
"taggedUserIds": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"gif": "https://media0.giphy.com/media/MCeIiRETfwBK2rtGRi/giphy.gif?cid=75a920b6w4tmpmwx92x4o0jkkh76knvq3b2ino26cgm5dgpn&rid=giphy.gif&ct=g",
"links": [
"string"
],
"newsTitle": "string",
"category": {},
"coverImage": "string",
"location": {
"textAddress": "string"
}
}
{
"id": "string",
"postText": "string",
"postedAt": "2022-12-16T06:46:21.283Z",
"commentsCount": 0,
"user": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
},
"files": {
"id": "string",
"mime": "string",
"path": "string",
"name": "string",
"processing": {},
"metadata": {},
"size": 0,
"url": "string",
"cdn": "string",
"bucket": "string",
"mp4Urls": [
"string"
],
"hlsUrl": "string",
"dashUrl": "string",
"thumbnail": "string",
"isImage": true,
"isVideo": true,
"isDoc": true,
"createdAt": "2022-12-16T06:46:21.283Z",
"owner": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
},
"linkPreviews": {
"title": "string",
"description": "string",
"image": "string",
"link": "string"
},
"tags": [
"string"
],
"reactions": [
{}
],
"mentions": [
{
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
],
"taggedUsers": [
{
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
],
"gif": "string",
"links": [
"string"
],
"reactionUsers": [
{
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
],
"location": {
"textAddress": "string"
}
}
| Parameter | Type | Schema Values | Nested Fields | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| permissions | string | any |
|
Permissions determines the visibility of the post. | ||||||||||
| postText | string | any | - | Text of the post. | ||||||||||
| status* required | string | PUBLISHED | - | Status of the post. | ||||||||||
| tags* required | Array |
any | - | Post tags. | ||||||||||
| mention | Array |
any | - | Mention Users in a post.Multiple users can be mentioned in a single post.You can get the list of Users through User listing API. | ||||||||||
| fileIds | Array |
any | - | Ids of pictures and videos media. Upload different media files using upload a media API | ||||||||||
| location | object | any |
|
Add the location. | ||||||||||
| taggedUserIds | Array |
any | - | Tag Users in a post.Multiple users can be tagged in a single post.You can get the list of Users through User listing API. | ||||||||||
| gif | URL | any | - | Link of the GIF media. | ||||||||||
| links | Array |
any | - | URL of multiple links.Through this API you can get all the Posts of a User's Organization that can be filtered on the basis of different types. |
Update a Post
Through this API you can update a new Post.
HTTP Request
PATCH https://[[API_SERVER_ENDPOINT]]/api/posts/id
Path Parameters
| Parameter | description |
|---|---|
| id | Id of the Post need to be updated |
Request Body
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"permissions": {
"users": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"groups": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"locations": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"public": true,
"friends": true,
"onlyMe": true,
"team": true
},
"tags": "#myfirstpost",
"mention": "6187fcb0-6151-11ec-9294-cfe91ad8177f",
"fileIds": [
"f5743644-c8ce-4bbe-a9bd-dfdd18dce445",
"1f1b75a3-f773-4fd6-a63e-9a5fb978b21e"
],
"taggedUserIds": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"gif": "https://media0.giphy.com/media/MCeIiRETfwBK2rtGRi/giphy.gif?cid=75a920b6w4tmpmwx92x4o0jkkh76knvq3b2ino26cgm5dgpn&rid=giphy.gif&ct=g",
"links": [
"string"
],
"newsTitle": "string",
"category": {},
"coverImage": "string",
"location": {
"textAddress": "string"
}
}
{
"id": "string",
"postText": "string",
"postedAt": "2022-12-16T06:46:21.283Z",
"commentsCount": 0,
"user": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
},
"files": {
"id": "string",
"mime": "string",
"path": "string",
"name": "string",
"processing": {},
"metadata": {},
"size": 0,
"url": "string",
"cdn": "string",
"bucket": "string",
"mp4Urls": [
"string"
],
"hlsUrl": "string",
"dashUrl": "string",
"thumbnail": "string",
"isImage": true,
"isVideo": true,
"isDoc": true,
"createdAt": "2022-12-16T06:46:21.283Z",
"owner": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
},
"linkPreviews": {
"title": "string",
"description": "string",
"image": "string",
"link": "string"
},
"tags": [
"string"
],
"reactions": [
{}
],
"mentions": [
{
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
],
"taggedUsers": [
{
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
],
"gif": "string",
"links": [
"string"
],
"reactionUsers": [
{
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
],
"location": {
"textAddress": "string"
}
}
| Parameter | Type | Schema Values | Nested Fields | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| permissions | string | any |
|
Update the permissions of the post. | ||||||||||
| postText | string | any | - | Text of the post. | ||||||||||
| status | string | PUBLISHED | - | Status of the post. | ||||||||||
| tags | Array |
any | - | Post tags. | ||||||||||
| mention | Array |
any | - | Mention Users in a post.Multiple users can be mentioned in a single post.You can get the list of Users through User Listing API. | ||||||||||
| fileIds | Array |
any | - | Ids of pictures and videos media. | ||||||||||
| location | object | any |
|
Update the location. | ||||||||||
| taggedUserIds | Array |
any | - | Tag Users in a post.Multiple users can be tagged in a single post.You can get the list of Users through User Listing API. | ||||||||||
| gif | URL | any | - | Link of the GIF media. | ||||||||||
| links | Array |
any | - | URL of multiple links. |
Delete a Post
Through this API you can delete any Post.
HTTP Request
Delete https://[[API_SERVER_ENDPOINT]]/api/posts/id
Path Parameters
| Parameter | description |
|---|---|
| id | Id of the Post need to be deleted |
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
News
Welcome to the News API! You can use our API to access News listing, Create, Update and Delete a News.
Get All News
Through this API you can get all the News of a User's Organization.
HTTP Request
GET https://[[API_SERVER_ENDPOINT]]/api/news
Query Parameters
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"time":"2022-10-17T09:21:41.247Z",
"per_page":"5",
"sort_key":"a"
}
{
"news": [
{
"id": "string",
"postedAt": "2022-12-16T06:38:30.150Z",
"commentsCount": 0,
"user": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
},
"files": {
"id": "string",
"mime": "string",
"path": "string",
"name": "string",
"processing": {},
"metadata": {},
"size": 0,
"url": "string",
"cdn": "string",
"bucket": "string",
"mp4Urls": [
"string"
],
"hlsUrl": "string",
"dashUrl": "string",
"thumbnail": "string",
"isImage": true,
"isVideo": true,
"isDoc": true,
"createdAt": "2022-12-16T06:38:30.150Z",
"owner": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
},
"linkPreviews": {
"title": "string",
"description": "string",
"image": "string",
"link": "string"
},
"tags": [
"string"
],
"reactions": [
{}
],
"mentions": [
{
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
],
"taggedUsers": [
{
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
],
"gif": "string",
"links": [
"string"
],
"newsTitle": "string",
"reactionUsers": [
{
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
],
"category": "string",
"coverImage": {
"id": "string",
"mime": "string",
"path": "string",
"name": "string",
"processing": {},
"metadata": {},
"size": 0,
"url": "string",
"cdn": "string",
"bucket": "string",
"mp4Urls": [
"string"
],
"hlsUrl": "string",
"dashUrl": "string",
"thumbnail": "string",
"isImage": true,
"isVideo": true,
"isDoc": true,
"createdAt": "2022-12-16T06:38:30.150Z",
"owner": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
},
"location": {
"textAddress": "string"
}
}
],
"meta": {
"perPage": 0,
"totalPages": 0,
"totalResults": 0,
"curPage": 0,
"nextPage": 0
}
}
| Parameter | Type | Default | Description |
|---|---|---|---|
| time* required | Time | Current Time | All the news till the specified time. |
| per_page | integer | 10 | Number of news to return. |
| sort_key | string | - | Select specific option from list below.
|
Create a News
Through this API you can create a new News.
HTTP Request
POST https://[[API_SERVER_ENDPOINT]]/api/news
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"permissions": {
"users": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"groups": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"locations": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"taggedUsers": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"public": true,
"friends": true,
"onlyMe": true,
"team": true
},
"tags": "#myfirstpost",
"mention": "6187fcb0-6151-11ec-9294-cfe91ad8177f",
"fileIds": [
"f5743644-c8ce-4bbe-a9bd-dfdd18dce445",
"1f1b75a3-f773-4fd6-a63e-9a5fb978b21e"
],
"taggedUserIds": [
"79ba2a88-448d-416a-9c22-c8e96ed8f873"
],
"gif": "https://media0.giphy.com/media/MCeIiRETfwBK2rtGRi/giphy.gif?cid=75a920b6w4tmpmwx92x4o0jkkh76knvq3b2ino26cgm5dgpn&rid=giphy.gif&ct=g",
"links": "https://www.google.com/",
"newsTitle": "World Cup",
"category": "Featured",
"coverImage": "ed91ba02-279f-49f9-98e9-33fdd8e09b95",
"location": {
"textAddress": "string"
}
}
{
"id": "string",
"postedAt": "2022-12-30T06:21:37.147Z",
"commentsCount": 0,
"user": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
},
"files": {
"id": "string",
"mime": "string",
"path": "string",
"name": "string",
"processing": {},
"metadata": {},
"size": 0,
"url": "string",
"cdn": "string",
"bucket": "string",
"mp4Urls": [
"string"
],
"hlsUrl": "string",
"dashUrl": "string",
"thumbnail": "string",
"isImage": true,
"isVideo": true,
"isDoc": true,
"createdAt": "2022-12-30T06:21:37.147Z",
"owner": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
},
"linkPreviews": {
"title": "string",
"description": "string",
"image": "string",
"link": "string"
},
"tags": [
"string"
],
"reactions": [
{}
],
"mentions": [
{
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
],
"taggedUsers": [
{
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
],
"gif": "string",
"links": [
"string"
],
"newsTitle": "string",
"reactionUsers": [
{
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
],
"category": "string",
"coverImage": {
"id": "string",
"mime": "string",
"path": "string",
"name": "string",
"processing": {},
"metadata": {},
"size": 0,
"url": "string",
"cdn": "string",
"bucket": "string",
"mp4Urls": [
"string"
],
"hlsUrl": "string",
"dashUrl": "string",
"thumbnail": "string",
"isImage": true,
"isVideo": true,
"isDoc": true,
"createdAt": "2022-12-30T06:21:37.148Z",
"owner": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
},
"location": {
"textAddress": "string"
}
}
| Parameter | Type | Schema Values | Nested Fields | Description |
|---|---|---|---|---|
| permissions | string | any | public: boolean friends: boolean onlyMe: boolean team: boolean |
Permissions determines the visibility of the news. |
| tags | Array |
any | - | News tags. |
| mention | Array |
any | - | Mention Users in a post.Multiple users can be mentioned in a single post.You can get the list of Users through User listing API. |
| fileIds | Array |
any | - | Ids of pictures and videos media. Upload any media file using a media API |
| location | object | any | textAddress: string coordinates
|
Add the location. |
| taggedUserIds | Array |
any | - | Tag Users in a post.Multiple users can be tagged in a single post.You can get the list of Users through User listing API. |
| gif | URL | any | - | Link of the GIF media. |
| links | Array |
any | - | URL of multiple links.Through this API you can get all the Posts of a User'sOrganization that can be filtered on the basis of different types. |
| newsTitle | string | any | - | Title of the news. |
| category | string | any | - | Catergory name. You can get the category listing through Categories Listing API |
| coverImage | uuid | any | - | Media Id of the coverImage of the news |
Update a News
Through this API you can update a new Post.`
HTTP Request
Parameters
PATCH https://[[API_SERVER_ENDPOINT]]/api/news/id
Parameter | description
--------- | -------
id | Id of the News need to be updated
`
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"permissions": {
"users": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"groups": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"locations": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"taggedUsers": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"public": true,
"friends": true,
"onlyMe": true,
"team": true
},
"tags": "#myfirstpost",
"mention": "6187fcb0-6151-11ec-9294-cfe91ad8177f",
"fileIds": [
"f5743644-c8ce-4bbe-a9bd-dfdd18dce445",
"1f1b75a3-f773-4fd6-a63e-9a5fb978b21e"
],
"taggedUserIds": [
"79ba2a88-448d-416a-9c22-c8e96ed8f873"
],
"gif": "https://media0.giphy.com/media/MCeIiRETfwBK2rtGRi/giphy.gif?cid=75a920b6w4tmpmwx92x4o0jkkh76knvq3b2ino26cgm5dgpn&rid=giphy.gif&ct=g",
"links": "https://www.google.com/",
"newsTitle": "World Cup",
"category": "Featured",
"coverImage": "ed91ba02-279f-49f9-98e9-33fdd8e09b95",
"location": {
"textAddress": "string"
}
}
{
"id": "string",
"postedAt": "2022-12-30T06:21:37.147Z",
"commentsCount": 0,
"user": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
},
"files": {
"id": "string",
"mime": "string",
"path": "string",
"name": "string",
"processing": {},
"metadata": {},
"size": 0,
"url": "string",
"cdn": "string",
"bucket": "string",
"mp4Urls": [
"string"
],
"hlsUrl": "string",
"dashUrl": "string",
"thumbnail": "string",
"isImage": true,
"isVideo": true,
"isDoc": true,
"createdAt": "2022-12-30T06:21:37.147Z",
"owner": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
},
"linkPreviews": {
"title": "string",
"description": "string",
"image": "string",
"link": "string"
},
"tags": [
"string"
],
"reactions": [
{}
],
"mentions": [
{
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
],
"taggedUsers": [
{
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
],
"gif": "string",
"links": [
"string"
],
"newsTitle": "string",
"reactionUsers": [
{
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
],
"category": "string",
"coverImage": {
"id": "string",
"mime": "string",
"path": "string",
"name": "string",
"processing": {},
"metadata": {},
"size": 0,
"url": "string",
"cdn": "string",
"bucket": "string",
"mp4Urls": [
"string"
],
"hlsUrl": "string",
"dashUrl": "string",
"thumbnail": "string",
"isImage": true,
"isVideo": true,
"isDoc": true,
"createdAt": "2022-12-30T06:21:37.148Z",
"owner": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
},
"location": {
"textAddress": "string"
}
}
| Parameter | Type | Schema Values | Nested Fields | Description |
|---|---|---|---|---|
| permissions | string | any | public: boolean friends: boolean onlyMe: boolean team: boolean |
Permissions determines the visibility of the post. |
| tags | Array |
any | - | Post tags. |
| mention | Array |
any | - | Mention Users in a post.Multiple users can be mentioned in a single post.You can get the list of Users through User listing API. |
| fileIds | Array |
any | - | Ids of pictures and videos media. Upload any media file using a media API |
| location | object | any | textAddress: string coordinates
|
Add the location. |
| taggedUserIds | Array |
any | - | Tag Users in a post.Multiple users can be tagged in a single post.You can get the list of Users through User listing API. |
| gif | URL | any | - | Link of the GIF media. |
| links | Array |
any | - | URL of multiple links. |
| newsTitle | string | any | - | Title of the news. |
| category | string | any | - | Catergory name. You can get the category listing through Categories Listing API |
| coverImage | uuid | any | - | Media Id of the coverImage of the news |
Delete a News
Through this API you can delete any Post.
HTTP Request
Delete https://[[API_SERVER_ENDPOINT]]/api/news/id
Parameters
| Parameter | description |
|---|---|
| id | Id of the News need to be deleted |
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
Event
In this section you can find the APIs that are use to access Event listing, Create, Update and Delete a Event.
Get All Events
Through this API you can get all the list of a Event's Organization.
GET https://[[API_SERVER_ENDPOINT]]/api/events
Query Parameters
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"fromDate":2022-12-16T00:00:00
"toDate":2022-12-30T23:59:59
"include_recent_rsvps":true
"per_page":1000
"time":2022-12-16T00:00:00
}
{
"events": [
{
"id": "string",
"createdAt": "2022-10-20T06:02:13.423Z",
"updatedAt": "2022-10-20T06:02:13.423Z",
"createdBy": "string",
"updatedBy": "string",
"title": "string",
"description": "string",
"externalLink": [
{
"title": "string",
"url": "string"
}
],
"isExternalEvent": true,
"conferenceLink": "string",
"location": "string",
"startDateTime": "2022-10-20T06:02:13.423Z",
"endDateTime": "2022-10-20T06:02:13.423Z",
"isVirtual": true,
"eventSource": "string",
"poster": {},
"going": 0,
"myRsvp": "string",
"myCheckin": "2022-10-20T06:02:13.423Z",
"comments": 0,
"tags": [
"string"
],
"reactions": [
"string"
],
"type": {},
"category": {},
"livestream": {
"id": "string",
"messageId": {},
"duration": 0,
"startedAt": "2022-10-20T06:02:13.423Z",
"endedAt": "2022-10-20T06:02:13.423Z",
"type": "string",
"status": "string",
"inProgress": true,
"isGroup": true,
"token": {},
"conversationId": {},
"noOfParticipants": 0,
"totalParticipants": 0,
"participants": [
{
"id": "string",
"userId": "string",
"callId": "string",
"agoraId": 0,
"user": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
},
"joinedAt": "2022-10-20T06:02:13.423Z",
"host": true,
"leftAt": {}
}
],
"livestreamConversationId": "string",
"title": {},
"eventForInvitesId": {},
"file": {
"id": "string",
"mime": "string",
"path": "string",
"name": "string",
"processing": {},
"metadata": {},
"size": 0,
"url": "string",
"cdn": "string",
"bucket": "string",
"mp4Urls": [
"string"
],
"hlsUrl": "string",
"dashUrl": "string",
"thumbnail": "string",
"isImage": true,
"isVideo": true,
"isDoc": true,
"createdAt": "2022-10-20T06:02:13.423Z",
"owner": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
},
"userId": "string",
"user": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
},
"scheduledFor": "2022-10-20T06:02:13.423Z",
"record": true,
"event": "string",
"publicToken": "string"
},
"rsvpUsers": [
{
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com",
"invited": "2022-10-20T06:02:13.423Z",
"rsvp": "string"
}
],
"creator": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
},
"externalAttendees": [
"string"
],
"repeatConfig": {
"config": {
"extras": {},
"config": {}
}
},
"repeatId": {}
}
],
"meta": {
"perPage": 0,
"totalPages": 0,
"totalResults": 0,
"curPage": 0,
"nextPage": 0
}
}
| Parameter | Type | Default | Description |
|---|---|---|---|
| time* required | Time | Current Time | All the events till the specified time. |
| per_page | integer | 10 | Number of results to return. |
| externalEvents | boolean | - | Mark true to get events imports from calendar(google/outlook) |
| filter | string | - | Filter the list of Events by selecting the options listed below.
|
| category | string | - | Specify the category of which you need to fetch the Events. Catrgories can be fetched through List categories API. |
| onlyPast | boolean | - | Mark true if you want to list down the Events that happend in Past. |
| include_happening_now | boolean | - | Mark true if you want to fetch the Events that are happening now |
| onlyMeeting | boolean | - | Mark true if you want to fetch only Meeting Type Events |
| onlyGoing | boolean | - | Mark true if you want to fetch the Events that you are going to attend |
| toDate | Date | - | Fetch Events that are going to be end till the entered Date |
| fromDate | Date | - | Fetch Events that are going to be start from the entered Date |
Create an Event
Through this API you can create a new Event. You can schedule a new Meeting through the parameters defined below.
HTTP Request
POST https://[[API_SERVER_ENDPOINT]]/api/events/meeting
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"permissions":{
"public":true,
"friends":false,
"onlyMe":false,
"team":false
},
"title":"new testing Event",
"description":"new testing event",
"externalLink":[
{
"title":"",
"url":"https://www.google.com/"
}
],
"userIds":[
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"conferenceLink":"string",
"location":"https://www.google.com/maps/d/viewer?ie=UTF8&hl=en&t=h&om=1&msa=0&ll=33.760326299999996%2C73.06671140000003&spn=0.001838%2C0.003787&z=19&mid=1GC-26pGg4Z58eto8mukpi6dyUj4",
"startDateTime":"2022-09-14T07:58:00.000Z",
"endDateTime":"2022-09-14T08:58:00.000Z",
"posterId":"c2b78442-6cb8-4f49-9a0b-53cdb8d8c95b",
"conversationId":"string",
"isVirtual":false,
"tags":[
"string"
],
"type":"2",
"externalUserEmails":[
"string"
],
"category":"Corporate Events",
"isMeeting":false,
"repeat":{
"config":{
"type":"frequency",
"frequency":86400,
"ends":{
"config":{
"type":"on",
"date":"2022-09-15"
}
}
}
},
"videoPreviewIds":[
"string"
],
"duration":0
}
{
"id": "string",
"createdAt": "2022-10-20T08:31:20.159Z",
"updatedAt": "2022-10-20T08:31:20.159Z",
"createdBy": "string",
"updatedBy": "string",
"title": "string",
"description": "string",
"externalLink": [
{
"title": "string",
"url": "string"
}
],
"isExternalEvent": true,
"conferenceLink": "string",
"location": "string",
"startDateTime": "2022-10-20T08:31:20.159Z",
"endDateTime": "2022-10-20T08:31:20.159Z",
"isVirtual": true,
"eventSource": "string",
"poster": {},
"going": 0,
"myRsvp": "string",
"myCheckin": "2022-10-20T08:31:20.159Z",
"comments": 0,
"tags": [
"string"
],
"reactions": [
"string"
],
"type": {},
"category": {},
"livestream": {
"id": "string",
"messageId": {},
"duration": 0,
"startedAt": "2022-10-20T08:31:20.159Z",
"endedAt": "2022-10-20T08:31:20.159Z",
"type": "string",
"status": "string",
"inProgress": true,
"isGroup": true,
"token": {},
"conversationId": {},
"noOfParticipants": 0,
"totalParticipants": 0,
"participants": [
{
"id": "string",
"userId": "string",
"callId": "string",
"agoraId": 0,
"user": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
},
"joinedAt": "2022-10-20T08:31:20.160Z",
"host": true,
"leftAt": {}
}
],
"livestreamConversationId": "string",
"title": {},
"eventForInvitesId": {},
"file": {
"id": "string",
"mime": "string",
"path": "string",
"name": "string",
"processing": {},
"metadata": {},
"size": 0,
"url": "string",
"cdn": "string",
"bucket": "string",
"mp4Urls": [
"string"
],
"hlsUrl": "string",
"dashUrl": "string",
"thumbnail": "string",
"isImage": true,
"isVideo": true,
"isDoc": true,
"createdAt": "2022-10-20T08:31:20.160Z",
"owner": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
},
"userId": "string",
"user": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
},
"scheduledFor": "2022-10-20T08:31:20.160Z",
"record": true,
"event": "string",
"publicToken": "string"
},
"rsvpUsers": [
{
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com",
"invited": "2022-10-20T08:31:20.160Z",
"rsvp": "string"
}
],
"creator": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
},
"externalAttendees": [
"string"
],
"repeatConfig": {
"config": {
"extras": {},
"config": {}
}
},
"repeatId": {}
}
Request Body
| Parameter | Type | Schema Values | Nested Fields | Description | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| permissions | string | any |
|
Permissions determines the visibility of the post.If you specify userIds in users option of permissions then event will only be shown to them. It is selected in case of Event type Events and Livestream. | |||||||||||||||||||||
| title | string | any | - | Title of the Event. | |||||||||||||||||||||
| description | string | any | - | Description of the Event. | |||||||||||||||||||||
| externalLink | Array | any |
|
External Link of an Event. | |||||||||||||||||||||
| userIds | Array |
any | - | In case of Meeting list down the invitees Users. You can get the list of users through User Listing API. | |||||||||||||||||||||
| isVirtual | boolean | true, false | - | Mark true if the Event is going to be virtually assist. | |||||||||||||||||||||
| conferenceLink | URL | any | - | It will be used only in case of Events(excluding meeting). If event is going to happen virtually this field will be used. | |||||||||||||||||||||
| location: | Location | any | - | Pin location link where Event will going to held. | |||||||||||||||||||||
| tags | Array |
any | - | Event tags. | |||||||||||||||||||||
| startDateTime | Date | any | - | Start date and time of the event. | |||||||||||||||||||||
| endtDateTime | Date | any | - | End date and time of the event. | |||||||||||||||||||||
| posterId | uuid | any | - | Media Id of the event's poster. Upload a poster media using media API | |||||||||||||||||||||
| type | integer | POST,LIVESTREAM,EVENT,FAQ,COURSE | - | Select the type of the event. | |||||||||||||||||||||
| externalUserEmails | Array |
any | - | Specify the external members emails in case of type Meeting. | |||||||||||||||||||||
| category | string | any | - | You can get the categories from Categories listing API. | |||||||||||||||||||||
| isMeeting | boolean | true, false | false | Mark true if the Event type is meeting. | |||||||||||||||||||||
| repeat | object | - |
|
Set the Recurrent Event values. | |||||||||||||||||||||
| videoPreviews | Array |
- | - | Media Ids of the videos in case of Event type LiveStream. Upload a video using upload a media API | |||||||||||||||||||||
| duration | integer | - | - | Set the event duration. |
Update an Event
Through this API you can update a new Event.
HTTP Request
PATCH https://[[API_SERVER_ENDPOINT]]/api/events/{id}
Path Parameters
| Parameter | description |
|---|---|
| id | Id of the Event need to be updated |
Query Parameters
| Parameter | description |
|---|---|
| repeat | Select weather to update all recrruent events or only events that will occur after this event. |
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"permissions":{
"public":true,
"friends":false,
"onlyMe":false,
"team":false
},
"title":"new testing Event",
"description":"new testing event",
"externalLink":[
{
"title":"",
"url":"https://www.google.com/"
}
],
"userIds":[
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"conferenceLink":"string",
"location":"https://www.google.com/maps/d/viewer?ie=UTF8&hl=en&t=h&om=1&msa=0&ll=33.760326299999996%2C73.06671140000003&spn=0.001838%2C0.003787&z=19&mid=1GC-26pGg4Z58eto8mukpi6dyUj4",
"startDateTime":"2022-09-14T07:58:00.000Z",
"endDateTime":"2022-09-14T08:58:00.000Z",
"posterId":"c2b78442-6cb8-4f49-9a0b-53cdb8d8c95b",
"conversationId":"string",
"isVirtual":false,
"tags":[
"string"
],
"type":"2",
"externalUserEmails":[
"string"
],
"category":"Corporate Events",
"isMeeting":false,
"repeat":{
"config":{
"type":"frequency",
"frequency":86400,
"ends":{
"config":{
"type":"on",
"date":"2022-09-15"
}
}
}
},
"videoPreviewIds":[
"string"
],
"duration":0
}
{
"id": "string",
"createdAt": "2022-10-20T08:31:20.159Z",
"updatedAt": "2022-10-20T08:31:20.159Z",
"createdBy": "string",
"updatedBy": "string",
"title": "string",
"description": "string",
"externalLink": [
{
"title": "string",
"url": "string"
}
],
"isExternalEvent": true,
"conferenceLink": "string",
"location": "string",
"startDateTime": "2022-10-20T08:31:20.159Z",
"endDateTime": "2022-10-20T08:31:20.159Z",
"isVirtual": true,
"eventSource": "string",
"poster": {},
"going": 0,
"myRsvp": "string",
"myCheckin": "2022-10-20T08:31:20.159Z",
"comments": 0,
"tags": [
"string"
],
"reactions": [
"string"
],
"type": {},
"category": {},
"livestream": {
"id": "string",
"messageId": {},
"duration": 0,
"startedAt": "2022-10-20T08:31:20.159Z",
"endedAt": "2022-10-20T08:31:20.159Z",
"type": "string",
"status": "string",
"inProgress": true,
"isGroup": true,
"token": {},
"conversationId": {},
"noOfParticipants": 0,
"totalParticipants": 0,
"participants": [
{
"id": "string",
"userId": "string",
"callId": "string",
"agoraId": 0,
"user": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
},
"joinedAt": "2022-10-20T08:31:20.160Z",
"host": true,
"leftAt": {}
}
],
"livestreamConversationId": "string",
"title": {},
"eventForInvitesId": {},
"file": {
"id": "string",
"mime": "string",
"path": "string",
"name": "string",
"processing": {},
"metadata": {},
"size": 0,
"url": "string",
"cdn": "string",
"bucket": "string",
"mp4Urls": [
"string"
],
"hlsUrl": "string",
"dashUrl": "string",
"thumbnail": "string",
"isImage": true,
"isVideo": true,
"isDoc": true,
"createdAt": "2022-10-20T08:31:20.160Z",
"owner": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
},
"userId": "string",
"user": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
},
"scheduledFor": "2022-10-20T08:31:20.160Z",
"record": true,
"event": "string",
"publicToken": "string"
},
"rsvpUsers": [
{
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com",
"invited": "2022-10-20T08:31:20.160Z",
"rsvp": "string"
}
],
"creator": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
},
"externalAttendees": [
"string"
],
"repeatConfig": {
"config": {
"extras": {},
"config": {}
}
},
"repeatId": {}
}
| Parameter | Type | Schema Values | Nested Fields | Description | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| permissions | string | any |
|
Update the permissions of the event. | |||||||||||||||||||||
| title | string | any | - | Update the title of the event. | |||||||||||||||||||||
| description | string | any | - | Update the description of the event. | |||||||||||||||||||||
| externalLink | Array | any |
|
update the external Link of the event. | |||||||||||||||||||||
| userIds | Array |
any | - | Update the invitees Users. You can get the list of users through User Listing API | |||||||||||||||||||||
| isVirtual | boolean | true, false | - | Mark true if the Event is going to be virtually assist. | |||||||||||||||||||||
| conferenceLink | URL | any | - | It will be used only in case of Events(excluding meeting). If event is going to happen virtually this field will be used. | |||||||||||||||||||||
| location: | Location | any | - | Update the location link where Event will going to held. | |||||||||||||||||||||
| tags | Array |
any | - | Update the event tags. | |||||||||||||||||||||
| startDateTime | Date | any | - | Update the start date and time of the event. | |||||||||||||||||||||
| endtDateTime | Date | any | - | Update the end date and time of the event. | |||||||||||||||||||||
| posterId | uuid | any | - | Update the media Id of the event's poster. Upload a poster media using upload a media API | |||||||||||||||||||||
| type | integer |
|
- | Update the type of the event. | |||||||||||||||||||||
| externalUserEmails | Array |
any | - | Update the external members emails in case of type Meeting. | |||||||||||||||||||||
| category | string | any | - | Update the category of the event. You can get the categories from List categories API. | |||||||||||||||||||||
| isMeeting | boolean | true, false | false | Mark true if the Event type is meeting. | |||||||||||||||||||||
| repeat | object | - |
|
Update the Recurrent Event values. | |||||||||||||||||||||
| videoPreviews | Array |
- | - | Update the media Ids of the videos in case of Event type LiveStream. Upload a video using upload a media API | |||||||||||||||||||||
| duration | integer | - | - | Update the event duration. |
Delete an Event
Through this API you can delete any Event.
HTTP Request
Delete https://[[API_SERVER_ENDPOINT]]/api/events/{id}
Path Parameters
| Parameter | description |
|---|---|
| id | Id of an Event need to be deleted |
Query Parameters
| Parameter | description |
|---|---|
| repeat | Select weather to delete all recrruent events or only events that will occur after this event. |
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
Video
In this section you can find the APIs that are use to access Video listing, Create, Update and Delete a Video.
Get All Videos
Through this API you can get all the list of a Video's Organization.
GET https://[[API_SERVER_ENDPOINT]]/api/videos
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"isFollowing": false,
"per_page": 28,
"search": ,
"cur_page": 1
}
{
"videos": [
{
"id": "string",
"createdAt": "2022-10-20T09:24:34.581Z",
"updatedAt": "2022-10-20T09:24:34.581Z",
"createdBy": "string",
"updatedBy": "string",
"title": "string",
"description": "string",
"source": 0,
"videoFileId": "string",
"user": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
},
"thumbnailFileId": "string",
"meta": {}
}
],
"meta": {
"perPage": 0,
"totalPages": 0,
"totalResults": 0,
"curPage": 0,
"nextPage": 0
}
}
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| cur_page | integer | 1 | A page number within the paginated result set. |
| per_page | integer | 10 | Number of results to return. |
| isFollowing | boolean | - | Set true to list all videos of the other users that the user is following |
| userId | string | - | For listing all videos uploaded by the specified user Id |
| search | string | - | List all the videos that have specified keywords in title and description |
Create a Video
Through this API you can create a new Event. You can schedule a new Meeting through the parameters defiend below.
HTTP Request
POST https://[[API_SERVER_ENDPOINT]]/api/videos
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"title": "Testing Video",
"description": "This is the testing Video",
"videoFileId": "f5743644-c8ce-4bbe-a9bd-dfdd18dce445",
"thumbnailFileId": "f5743644-c8ce-4bbe-a9bd-dfdd18dce445",
"meta": {},
"permissions": {
"users": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"groups": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"locations": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"taggedUsers": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"public": true,
"friends": true,
"onlyMe": true,
"team": true
}
}
{
"id":"string",
"createdAt":"2022-10-20T12:46:59.074Z",
"updatedAt":"2022-10-20T12:46:59.074Z",
"createdBy":"string",
"updatedBy":"string",
"title":"string",
"description":"string",
"source":0,
"videoFileId":"string",
"user":{
"id":"string",
"firstName":"string",
"lastName":"string",
"picture":{},
"cover":{},
"color":"string",
"online":true,
"availability":1,
"designation":{},
"department":{},
"availabilityStatusText":"string",
"phone":"string",
"email":"user@example.com",
"status":"user@example.com"
},
"thumbnailFileId":"string",
"meta":{
}
}
| Parameter | Type | Schema Values | Nested Fields | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| permissions | string | any |
|
Permissions determines the visibility of the post.If you specify userIds in users option of permissions then video will only be shown to them. It is selected in case of Event type Events and Livestream. | ||||||||||||
| title | string | any | - | Title of the Video. | ||||||||||||
| description | string | any | - | Description of the Video. | ||||||||||||
| videoFileId | uuid | any | - | Id of the video media. Upload a video using media API | ||||||||||||
| thumbnailFileId | uuid | any | - | Id of the video Thumbnail media. Upload a video thumbnail using a media API | ||||||||||||
| meta | object | - |
|
URl of external media | ||||||||||||
| source | number | YOUTUBE: 1 VIMEO: 2 CUSTOM: 3 RECORDING:4 |
- | Specify the source of the video |
Update a Video
Through this API you can update a new Video.
HTTP Request
PATCH https://[[API_SERVER_ENDPOINT]]/api/videos/{id}
Path Parameters
| Parameter | description |
|---|---|
| id | Id of the Video need to be updated |
Request Body
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"title":"Testing Video",
"description":"This is the testing Video",
"thumbnailFileId":"f5743644-c8ce-4bbe-a9bd-dfdd18dce445",
"permissions":{
"users":[
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"groups":[
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"locations":[
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"public":true,
"friends":true,
"onlyMe":true,
"team":true
}
}
`
{
"id":"string",
"createdAt":"2022-10-20T12:46:59.074Z",
"updatedAt":"2022-10-20T12:46:59.074Z",
"createdBy":"string",
"updatedBy":"string",
"title":"string",
"description":"string",
"source":0,
"videoFileId":"string",
"user":{
"id":"string",
"firstName":"string",
"lastName":"string",
"picture":{},
"cover":{},
"color":"string",
"online":true,
"availability":1,
"designation":{},
"department":{},
"availabilityStatusText":"string",
"phone":"string",
"email":"user@example.com",
"status":"user@example.com"
},
"thumbnailFileId":"string",
"meta":{
}
}
| Parameter | Type | Schema Values | Nested Fields | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| permissions | string | any |
|
Permissions determines the visibility of the post.If you specify userIds in users option of permissions then event will only be shown to them. It is selected in case of Event type Events and Livestream. | ||||||||||||
| title | string | any | - | Title of the Video. | ||||||||||||
| description | string | any | - | Description of the Video. | ||||||||||||
| thumbnailFileId | uuid | any | - | Id of the video Thumbnail media. Upload a thumbnail using a media API |
Delete a Video
Through this API you can delete any Event.
HTTP Request
Delete https://[[API_SERVER_ENDPOINT]]/api/videos/{id}
Path Parameters
| Parameter | description |
|---|---|
| id | Id of an Video need to be deleted |
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
Photo
In this section you can find the APIs that are use to access Photo listing, Create, Update and Delete a Photo.
Get All Photos
Through this API you can get all the list of a Photo's Organization.
GET https://[[API_SERVER_ENDPOINT]]/api/photos
Query Parameters
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"cur_page":1,
"per_page":"5",
"filter":"all_photos"
}
{
"photos": [
{
"id": "string",
"createdAt": "2022-10-20T19:03:51.880Z",
"updatedAt": "2022-10-20T19:03:51.880Z",
"createdBy": "string",
"updatedBy": "string",
"title": "string",
"description": "string",
"photo": {},
"user": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
}
],
"meta": {
"perPage": 0,
"totalPages": 0,
"totalResults": 0,
"curPage": 0,
"nextPage": 0
}
}
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| cur_page | integer | 1 | A page number within the paginated result set. |
| per_page | integer | 10 | Number of results to return. |
| filter | boolean | - | Filter the photos by choosing the following terms
|
| userId | string | - | For listing all photos uploaded by the specified user Id. You can get the user ids by using the User Listing API |
Create a Photo
Through this API you can create a new Photo.
POST https://[[API_SERVER_ENDPOINT]]/api/photos
Request Body
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"title": "Testing Photo",
"description": "This is the testing Photo",
"fileId": "f5743644-c8ce-4bbe-a9bd-dfdd18dce445",
"permissions": {
"users": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"groups": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"locations": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"taggedUsers": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"public": true,
"friends": true,
"onlyMe": true,
"team": true
}
}
{
"id":"string",
"createdAt":"2022-10-20T19:28:35.125Z",
"updatedAt":"2022-10-20T19:28:35.125Z",
"createdBy":"string",
"updatedBy":"string",
"title":"string",
"description":"string",
"photo":{},
"user":{
"id":"string",
"firstName":"string",
"lastName":"string",
"picture":{},
"cover":{},
"color":"string",
"online":true,
"availability":1,
"designation":{},
"department":{},
"availabilityStatusText":"string",
"phone":"string",
"email":"user@example.com",
"status":"user@example.com"
}
}
| Parameter | Type | Schema Values | Nested Fields | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| permissions | string | any |
|
Permissions determines the visibility of the photo.If you specify userIds in users option of permissions then photo will only be shown to them. | ||||||||||||
| title | string | any | - | Title of the Photo. | ||||||||||||
| description | string | any | - | Description of the Photo. | ||||||||||||
| fileId | uuid | any | - | Id of the photo media. Upload a photo using a media API |
Update a Photo
Through this API you can update a new Photo.
HTTP Request
PATCH https://[[API_SERVER_ENDPOINT]]/api/photos/{id}
Path Parameters
| Parameter | description |
|---|---|
| id | Id of the Photo need to be updated |
Request Body
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"title": "Testing Photo",
"description": "This is the testing Photo"
}
{
"id":"string",
"createdAt":"2022-10-20T19:28:35.125Z",
"updatedAt":"2022-10-20T19:28:35.125Z",
"createdBy":"string",
"updatedBy":"string",
"title":"string",
"description":"string",
"photo":{},
"user":{
"id":"string",
"firstName":"string",
"lastName":"string",
"picture":{},
"cover":{},
"color":"string",
"online":true,
"availability":1,
"designation":{},
"department":{},
"availabilityStatusText":"string",
"phone":"string",
"email":"user@example.com",
"status":"user@example.com"
}
}
| Parameter | Type | Schema Values | Nested Fields | Description |
|---|---|---|---|---|
| title | string | any | - | Title of the Photo. |
| description | string | any | - | Description of the Photo. |
Delete a Photo
Through this API you can delete any Photo.
HTTP Request
Delete https://[[API_SERVER_ENDPOINT]]/api/photos/{id}
Path Parameters
| Parameter | description |
|---|---|
| id | Id of an Photo need to be deleted |
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
Document
Welcome to the Document API! You can use our API to access Document listing, Create, Update and Delete a Document.
Get All Documents
Through this API you can get all the Documents of a User's Organization.
HTTP Request
GET https://[[API_SERVER_ENDPOINT]]/api/documents
Query Parameters
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"cur_page":1,
"per_page":"5",
"category":"Human resource"
}
{
"docs": [
{
"id": "string",
"name": {},
"metadata": {},
"isPublished": true,
"updatedAt": "2022-10-21T05:41:12.836Z",
"expiry": "2022-10-21T05:41:12.836Z",
"file": {
"id": "string",
"mime": "string",
"path": "string",
"name": "string",
"processing": {},
"metadata": {},
"size": 0,
"url": "string",
"cdn": "string",
"bucket": "string",
"mp4Urls": [
"string"
],
"hlsUrl": "string",
"dashUrl": "string",
"thumbnail": "string",
"isImage": true,
"isVideo": true,
"isDoc": true,
"createdAt": "2022-10-21T05:41:12.836Z",
"owner": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
},
"tags": [
"string"
],
"category": "string",
"owners": [
{
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
],
"bookmarkId": {},
"linkPreview": [
{
"title": "string",
"description": "string",
"image": "string",
"link": "string"
}
]
}
],
"meta": {
"perPage": 0,
"totalPages": 0,
"totalResults": 0,
"curPage": 0,
"nextPage": 0
}
}
| Parameter | Type | Default | Description |
|---|---|---|---|
| cur_page | integer | 1 | A page number within the paginated result set. |
| per_page | integer | 10 | Number of results to return. |
| category | string | - | Specify the specific category of which you need to fetch the Documents. Categories can be fetched through List categories API. |
Upload a Document
Through this API you can Upload a new Document.
HTTP Request
POST https://[[API_SERVER_ENDPOINT]]/api/documents
Query Parameters
| Parameter | description |
|---|---|
| publish | Set to true if you want to publish the document. |
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"name": "string",
"ownerIds": [
"string"
],
"expiry": "2022-10-21T05:44:06.323Z",
"tags": [
"string"
],
"category": "string",
"docUrl": "string",
"link": "string",
"docId": "string",
"permissions": {
"users": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"groups": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"locations": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"taggedUsers": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"public": true,
"friends": true,
"onlyMe": true,
"team": true
}
}
{
"name": "string",
"ownerIds": [
"string"
],
"expiry": "2022-10-26T07:16:25.738Z",
"tags": [
"string"
],
"category": "string",
"docUrl": "string",
"link": "string",
"docId": "string",
"permissions": {
"users": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"groups": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"locations": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"taggedUsers": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"public": true,
"friends": true,
"onlyMe": true,
"team": true
}
}
Request Body
| Parameter | Type | Schema Values | Nested Fields | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| permissions | string | any |
|
Permissions determines the visibility of the post. | ||||||||||
| name | string | any | - | Name of the document. | ||||||||||
| ownerIds | Array |
any | - | User Ids of the documents owners.You can get the User Ids from the User Listing API. | ||||||||||
| tags | Array |
any | - | Documents tags. | ||||||||||
| expiry | Date | any | - | Expiry date of the document. | ||||||||||
| category | string | any | - | Category of the document. You can get the list of existing categories through List categories API or you can create a new category. | ||||||||||
| link | URL | any | - | Link that contains the document information. | ||||||||||
| docURL | URL | any | - | Document URL. | ||||||||||
| docId | uuid | any | - | Document media Id. You can upload the document using the media API |
Update a Document
Through this API you can update a Document.
HTTP Request
PATCH https://[[API_SERVER_ENDPOINT]]/api/documnents
Path Parameters
| Parameter | description |
|---|---|
| id | Id of the Document need to be updated |
Query Parameters
| Parameter | description |
|---|---|
| publish | Set to true if you want to publish the document. |
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"docId": "string",
"docUrl": "string",
"kb": {
"name": "string",
"newOwnerIds": [
"0fdd5bf6-e975-4f44-bbd9-b4c9900dacb5"
],
"removeOwnerIds": [
"c8f0e467-cf18-4677-a78e-6b63fd3bedac"
],
"expiry": "2022-10-21T06:49:44.790Z",
"tags": [
"string"
],
"category": "string",
"link": "string",
"isPublished": true,
"permissions": {
"users": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"groups": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"locations": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"public": true,
"friends": true,
"onlyMe": true,
"team": true
}
},
"permissions": {
"users": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"groups": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"locations": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"public": true,
"friends": true,
"onlyMe": true,
"team": true
}
}
{
"id": "string",
"name": {},
"metadata": {},
"isPublished": true,
"updatedAt": "2022-10-21T06:58:14.936Z",
"expiry": "2022-10-21T06:58:14.936Z",
"file": {
"id": "string",
"mime": "string",
"path": "string",
"name": "string",
"processing": {},
"metadata": {},
"size": 0,
"url": "string",
"cdn": "string",
"bucket": "string",
"mp4Urls": [
"string"
],
"hlsUrl": "string",
"dashUrl": "string",
"thumbnail": "string",
"isImage": true,
"isVideo": true,
"isDoc": true,
"createdAt": "2022-10-21T06:58:14.936Z",
"owner": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
},
"tags": [
"string"
],
"category": "string",
"owners": [
{
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
],
"bookmarkId": {},
"linkPreview": [
{
"title": "string",
"description": "string",
"image": "string",
"link": "string"
}
]
}
| Parameter | Type | Schema Values | Nested Fields | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| kb | object | - |
|
Description of the fields is given in upload Document APIsection. | ||||||||||||||||
| docURL | URL | any | - | Document URL. | ||||||||||||||||
| docId | uuid | any | - | Document media Id. You can upload the document using the media API |
Delete a Document
Through this API you can delete any Document.
HTTP Request
Delete https://[[API_SERVER_ENDPOINT]]/api/documents
Parameters
| Parameter | description |
|---|---|
| id | Id of the Document need to be deleted |
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
FAQ
In this section you can find the APIs that are use to access FAQ listing, Create, Update and Delete a FAQ.
Get All FAQs
Through this API you can get all the FAQs of a User's Organization.
HTTP Request
GET https://[[API_SERVER_ENDPOINT]]/api/faqs
Query Parameters
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"cur_page":1,
"per_page":"5",
"category":"Human resource"
}
{
"data": [
{
"id": "string",
"question": "I have some queries related to refund policy",
"answer": "Refund Policy have a lot of aspects that are being categorized into multiple policies",
"description": "If you are not satisfied then feel free to contact us",
"category": "Refund Policy",
"tags": "Refund Policy",
"owners": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"bookmarkId": {}
}
],
"meta": {
"perPage": 0,
"totalPages": 0,
"totalResults": 0,
"curPage": 0,
"nextPage": 0
}
}
| Parameter | Type | Default | Description |
|---|---|---|---|
| cur_page | integer | 1 | A page number within the paginated result set. |
| per_page | integer | 10 | Number of results to return. |
| category | string | - | Specify the specific category of which you need to fetch the FAQs. Categories can be fetched through List categories API. |
Upload a FAQ
Through this API you can Upload a new FAQ.
HTTP Request
POST https://[[API_SERVER_ENDPOINT]]/api/faqs
Query Parameters
| Parameter | description |
|---|---|
| publish | Set to true if you want to publish the FAQ. |
Request Body
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"kb": {
"name": {},
"ownerIds": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"expiry": "2022-10-21T07:54:29.801Z",
"tags": [
"string"
],
"category": "string"
},
"qas": [
{
"question": "string",
"answer": "string",
"description": "string"
}
],
"permissions": {
"users": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"groups": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"locations": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"taggedUsers": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"public": true,
"friends": true,
"onlyMe": true,
"team": true
}
}
"kb": {
"name": {},
"ownerIds": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"expiry": "2022-10-21T10:06:17.192Z",
"tags": [
"string"
],
"category": "string"
},
"qas": [
{
"question": "string",
"answer": "string",
"description": "string"
}
],
"permissions": {
"users": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"groups": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"locations": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"taggedUsers": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"public": true,
"friends": true,
"onlyMe": true,
"team": true
}
}
| Parameter | Type | Schema Values | Nested Fields | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| permissions | string | any |
|
Permissions determines the visibility of the post. | ||||||||||||
| kb | object | - |
|
Contains the basic information of the FAQ | ||||||||||||
| qas | Array | any |
|
Array of questions, answers and descriptions. |
Update a FAQ
Through this API you can update a FAQ.
HTTP Request
PATCH https://[[API_SERVER_ENDPOINT]]/api/faqs/{kbId}
Query Parameters
| Parameter | description |
|---|---|
| kbId | Id of the FAQ need to be updated. |
Path Parameters
| Parameter | description |
|---|---|
| publish | Mark true if you want to publish a FAQ. |
Request Body
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"kb": {
"name": "string",
"newOwnerIds": [
"0fdd5bf6-e975-4f44-bbd9-b4c9900dacb5"
],
"removeOwnerIds": [
"c8f0e467-cf18-4677-a78e-6b63fd3bedac"
],
"expiry": "2022-10-21T10:06:17.198Z",
"tags": [
"string"
],
"category": "string",
"link": "string",
},
"updatedQAs": [
{
"id": "string",
"question": "string",
"answer": "string",
"description": "string"
}
],
"newQas": [
{
"question": "string",
"answer": "string",
"description": "string"
}
],
"removeQuestionIds": [
"0fdd5bf6-e975-4f44-bbd9-b4c9900dacb5"
],
"permissions": {
"users": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"groups": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"locations": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"public": true,
"friends": true,
"onlyMe": true,
"team": true
}
}
"kb": {
"name": {},
"ownerIds": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"expiry": "2022-10-21T10:06:17.192Z",
"tags": [
"string"
],
"category": "string"
},
"qas": [
{
"question": "string",
"answer": "string",
"description": "string"
}
],
"permissions": {
"users": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"groups": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"locations": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"taggedUsers": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"public": true,
"friends": true,
"onlyMe": true,
"team": true
}
}
| Parameter | Type | Schema Values | Nested Fields | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| permissions | string | any |
|
Permissions determines the visibility of the post. | ||||||||||||
| kb | object | - |
|
Enter the information about the FAQ name, ownerIds, tags , FAQ expiry and category. | ||||||||||||
| qas | Array | any |
|
Array of questions, answers and description. |
Delete a FAQ
Through this API you can delete any FAQ.
HTTP Request
Delete https://[[API_SERVER_ENDPOINT]]/api/faqs/{id}
Path Parameters
| Parameter | description |
|---|---|
| id | Id of the FAQ need to be deleted |
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
Category
Welcome to the Category API! You can use our API to access categories of different module codes.
Get All Categories
Through this API you can get all categories of different module. Each module have a specific code. You can get the list of codes using ModuleCodes listing API.
HTTP Request
GET https://[[API_SERVER_ENDPOINT]]/api/categories
Query Parameters
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"cur_page":1,
"per_page":5,
"moduleCode":1
}
{
"categories": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"moduleCode": 0,
"category": "string",
"color": "string",
"orgId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
],
"meta": {
"perPage": 0,
"totalPages": 0,
"totalResults": 0,
"curPage": 0,
"nextPage": 0
}
}
| Parameter | Type | Default | Description |
|---|---|---|---|
| cur_page | integer | 1 | A page number within the paginated result set. |
| per_page | integer | 10 | Number of results to return. |
| moduleCode* | integer | - | Enter the code of the module. Each module have a specific code. You can get the list of codes using ModuleCodes listing API. |
Enforcement Template
In this section you can find the API that is use to fetch all the enforcement templates of a specific organization.
Get All Templates
This API is use to get the list of all the enforcement templates of a User's organization
HTTP Request
GET https://[[API_SERVER_ENDPOINT]]/api/enforcement-templates
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"cur_page":1,
"per_page":5,
"sort_direction":'ASC'
}
{
"notificationTemplates": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"title": "string",
"systemEvent": "string",
"type": "string",
"subType": "string",
"reminders": [
{
"reminderType": "email | push | text | restrict",
"reminderTimeUnit": "week | days | hours | minutes",
"reminderTime": 0,
"refId": "1",
"orgContentTemplateId": "string"
}
]
}
],
"meta": {
"perPage": 0,
"totalPages": 0,
"totalResults": 0,
"curPage": 0,
"nextPage": 0
}
}
Query Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| cur_page | integer | 1 | A page number within the paginated result set. |
| per_page | integer | 10 | Number of results to return. |
| sort_direction | string | DESC | Sort Direction of the results. Sorting will done according to the templates creation date. |
Notification
In this section you can find the API that is use to send a new notification through different mediums.
Send a new Notification
Through this API you can new notification through different mediums.
HTTP Request
GET https://[[API_SERVER_ENDPOINT]]/api/notifications/send
Request Body
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"title": "Sending WorkDrive Email",
"description": "I want to notify about an event",
"medium": "EMAIL",
"emails": [
"abc@domain.com"
],
"receiverUserIds": [
"e198ac3a-4ac4-11ed-b878-0242ac120002"
]
}
}
| Parameter | Type | Schema Values | Description |
|---|---|---|---|
| title | string | any | Define the subject of the notification. |
| description | string | any | Define the description of the notification. |
| medium | string | EMAIL, SMS, PUSH, INAPP | Select the medium of your notification. |
| emails | Array |
any | In case of medium type EMAIL this field is required. It contains the emails of users on which email will be send. |
| recieverUserIds | Array |
any | In all mediums except EMAIL, this field is required. It contains the ids of the users on which notification will be send.You can get the list of Users through User Listing API |
Module Codes
In this section you can find the API that is use to list down all the codes of the modules.
Get Module Codes
Through this API to list down all the codes of the modules.
HTTP Request
GET https://[[API_SERVER_ENDPOINT]]/api/module-codes
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
[
{
"name": "POST",
"moduleCode": 1
}
]
Course
Welcome to the Course API! You can use our API to get list of all courses and to delete course.
Get All Courses
Through this API you can get all categories of different module. Each module have a specific code.
HTTP Request
GET https://[[API_SERVER_ENDPOINT]]/api/categories
Query Parameters
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"cur_page":1,
"per_page":5,
"filter":'ALL_COURSES',
"sort_direction" : 'ASC'
}
{
"taskLists": [
{
"id": "string",
"courseId": "string",
"title": "Fill out timeSheet",
"description": "TimeSheet completion is a good self-management technique",
"categories": [
"Business",
"Development"
],
"order": "Order of taskList",
"numberOfTasks": "Total number of tasks in taskList",
"usersCount": "Total number of users in taskList",
"totalTime": "Time estimated time of task",
"orgId": "1",
"tasks": 1,
"parentTaskListId": "string",
"progress": 0,
"updatedAt": "2022-10-23T12:32:57.449Z",
"status": "string",
"file": {
"id": "string",
"mime": "string",
"path": "string",
"name": "string",
"processing": {},
"metadata": {},
"size": 0,
"url": "string",
"cdn": "string",
"bucket": "string",
"mp4Urls": [
"string"
],
"hlsUrl": "string",
"dashUrl": "string",
"thumbnail": "string",
"isImage": true,
"isVideo": true,
"isDoc": true,
"createdAt": "2022-10-23T12:32:57.450Z",
"owner": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
},
"form": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"createdAt": "2022-10-23T12:32:57.450Z",
"updatedAt": "2022-10-23T12:32:57.450Z",
"title": "Employment form",
"accepting": true,
"type": {},
"schema": {
"data": {
"components": [
{
"input": true,
"tableView": true,
"inputType": "text",
"inputMask": "",
"label": "First Name",
"key": "firstName",
"placeholder": "Enter your first name",
"prefix": "",
"suffix": "",
"multiple": false,
"defaultValue": "",
"protected": false,
"unique": false,
"persistent": true,
"validate": {
"required": false,
"minLength": "",
"maxLength": "",
"pattern": "",
"custom": "",
"customPrivate": false
},
"conditional": {
"show": false,
"when": null,
"eq": ""
},
"type": "textfield"
},
{
"type": "button",
"theme": "primary",
"disableOnInvalid": true,
"action": "submit",
"block": false,
"rightIcon": "",
"leftIcon": "",
"size": "md",
"key": "submit",
"tableView": false,
"label": "Submit",
"input": true
}
],
"display": "form"
}
}
},
"dueDate": {},
"started": true,
"createdBy": "1",
"notificationTemplateId": "string"
}
],
"meta": {
"perPage": 0,
"totalPages": 0,
"totalResults": 0,
"curPage": 0,
"nextPage": 0
}
}
| Parameter | Type | Schema Values | Default | Description |
|---|---|---|---|---|
| cur_page | integer | - | 1 | A page number within the paginated result set. |
| per_page | integer | - | 10 | Number of results to return. |
| filter | integer | any | - | Choose t. You can get the list of codes using ModuleCodes listing API. |
| sort_direction | string | ASC, DESC | ASC | Sort Direction of the results. Sorting will done according to the courses creation date. |
Delete a Course
Through this API you can delete any Course of the User.
HTTP Request
Delete https://[[API_SERVER_ENDPOINT]]/api/courses/{id}
Parameters
| Parameter | description |
|---|---|
| id | Id of the Course need to be deleted |
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
Task
In this section you can find the APIs that are use to access Task listing, Create, Update and Delete a Task.
Get All Tasks
Through this API you can get all the Tasks of a User.
HTTP Request
GET https://[[API_SERVER_ENDPOINT]]/api/tasks
Query Parameters
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"per_page" : 5,
"cur_page" : 1,
"sort_direction" : 'DESC',
"filter" : 'INDEPENDENT_TASKS_CREATED_BY_ME',
"published" : false
}
{
"tasks": [
{
"id": "string",
"title": "Fill out timeSheet",
"content": "Fill time sheet at end of day",
"time": 1,
"videoId": "string",
"description": "string",
"link": "string",
"dueDate": "2022-12-29T06:25:47.432Z",
"status": "string",
"createdBy": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"departmentData": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
},
"createdAt": "2022-12-29T06:25:47.434Z",
"dueDays": 0,
"trainingCourse": {},
"trainingCourseTaskListId": "string",
"updatedAt": "2022-12-29T06:25:47.434Z"
}
],
"meta": {
"perPage": 0,
"totalPages": 0,
"totalResults": 0,
"curPage": 0,
"nextPage": 0
}
}
| Parameter | Type | Default | Description |
|---|---|---|---|
| cur_page | integer | 1 | A page number within the paginated result set. |
| per_page | integer | 10 | Number of results to return. |
| sort_direction | string | ASC | Specify the sort direction according to which you want to view tasks. |
| filter | string | - | Filter out tasks by using these filters: INDEPENDENT_TASKS_CREATED_BY_ME, INDEPENDENT_TASKS_ASSIGNED_TO_ME . |
Create a Task
Through this API you can Create and publish a new Task .
HTTP Request
POST https://[[API_SERVER_ENDPOINT]]/api/tasks
Request Body
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"title": "Task List Title",
"description": "Task List description ",
"status": "Task List status ",
"task_type": "Article",
"notificationTemplateId": "string",
"content": "Fill time sheet at end of day",
"time": 1,
"videoId": "Id of Video",
"description": "string",
"link": "https://abc.com",
"dueDays": 0,
"documentId": "Id of knowledgebase/document",
"trainingCourseTaskListId": "Id of training Course"
}
{
"id": "string",
"title": "Fill out timeSheet",
"content": "Fill time sheet at end of day",
"time": 1,
"videoId": "string",
"description": "string",
"link": "string",
"dueDate": "2022-12-29T06:25:47.269Z",
"status": "string",
"createdAt": "2022-12-29T06:25:47.269Z",
"dueDays": 0,
"trainingCourse": {},
"trainingCourseTaskListId": "string",
"updatedAt": "2022-12-29T06:25:47.269Z",
"createdBy": "string"
}
| Parameter | Type | Schema Values | Nested Fields | Description |
|---|---|---|---|---|
| title | string | any | - | Title of the task |
| description | string | any | - | Description of the tasklist in which task is going to be created. |
| status | string | draft, publish | - | Is the task publish or a draft. If the status is draft it cannot be assigned to any other user. |
| notificationTemplateId | uuid | any | - | Template Id of the tasklist. You can get the list of notification Templates through Enforcement Template Listing API. |
| task_type | string | Article, Video, QuizLink, Document, TrainingCourse | - | Type of the task. |
| content | string | any | - | Incase of task type Article the content field is required for the article content. |
| description | string | any | - | Description of the task. This field will be use in task type : Video, QuizLink, Document, TrainingCourse |
| link | URL | any | - | Link of the task in case of task type Link |
| dueDays | number | any | - | Number of days in which a task has to be done |
| documentId | uuid | any | - | Id of the document in case of the task type Document. You can get the id of the documents through Documnet Listing API |
| trainingCourseTaskListId | uuid | any | - | Id of the course linked in the case of task type Course. You can get the ids of Courses through Courses Listing API |
| videoId | uuid | any | - | You can upload a new video and use an Id of an uploaded Video. In case of uploading a new video a media Id of the video will be used. Upload a video using upload a media API |
Create and Assign a Task
Through this API you can Create and publish a new Task .
HTTP Request
POST https://[[API_SERVER_ENDPOINT]]/api/tasks
Request Body
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"notificationTemplateId": "string",
"title": "Task Title",
"description": "Task description ",
"content": "Fill time sheet at end of day",
"time": 1,
"task_type": "Article",
"videoId": "Id of Video",
"link": "https://abc.com",
"dueDays": 0,
"documentId": "Id of knowledgebase/document",
"userIds": [
"string"
]
}
{
"id": "string",
"title": "Fill out timeSheet",
"content": "Fill time sheet at end of day",
"time": 1,
"videoId": "string",
"description": "string",
"link": "string",
"dueDate": "2022-12-15T10:56:24.089Z",
"status": "string",
"assignedUserIds": [
"44816196-e410-41de-9336-1e9560957845"
]
}
| Parameter | Type | Schema Values | Nested Fields | Description |
|---|---|---|---|---|
| title | string | any | - | Title of the task |
| description | string | any | - | Description of the tasklist in which task is going to be created. |
| notificationTemplateId | uuid | any | - | Template Id of the tasklist. You can get the list of notification Templates through Enforcement Template Listing API. |
| task_type | string | Article, Video, QuizLink, Document, TrainingCourse | - | Type of the task. |
| content | string | any | - | Incase of task type Article the content field is required for the article content. |
| description | string | any | - | Description of the task. This field will be use in task type : Video, QuizLink, Document, TrainingCourse |
| link | URL | any | - | Link of the task in case of task type Link |
| dueDays | number | any | - | Number of days in which a task has to be done |
| documentId | uuid | any | - | Id of the document in case of the task type Document. You can get the id of the documents through Documnet Listing API |
| trainingCourseTaskListId | uuid | any | - | Id of the course linked in the case of task type Course. You can get the ids of Courses through Courses Listing API |
| videoId | uuid | any | - | You can upload a new video and use an Id of an uploaded Video. In case of uploading a new video a media Id of the video will be used. Upload a video using upload a media API |
| userIds | Array<String> | any | - | Ids of the users to which a task should be assigned. You can the list of user ids through User Listing API |
Update a Task
Through this API you can update a Task.
HTTP Request
PATCH https://[[API_SERVER_ENDPOINT]]/api/tasks/update/id
Path Parameters
| Parameter | description |
|---|---|
| id | Id of the Task need to be updated |
Request Body
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"notificationTemplateId": "string",
"title": "Task List Title",
"description": "Task List description ",
"status": "published",
"content": "Fill time sheet at end of day",
"time": 1,
"task_type": "Article",
"videoId": "Id of Video",
"link": "https://abc.com",
"dueDays": 0,
"documentId": "Id of knowledgebase/document",
"trainingCourseTaskListId": "string"
}
{
"id": "string",
"title": "Fill out timeSheet",
"content": "Fill time sheet at end of day",
"time": 1,
"videoId": "string",
"description": "string",
"link": "string",
"dueDate": "2022-12-29T06:25:47.269Z",
"status": "string",
"createdAt": "2022-12-29T06:25:47.269Z",
"dueDays": 0,
"trainingCourse": {},
"trainingCourseTaskListId": "string",
"updatedAt": "2022-12-29T06:25:47.269Z",
"createdBy": "string"
}
| `Parameter | Type | Schema Values | Nested Fields | Description |
|---|---|---|---|---|
| title | string | any | - | Title of the task |
| description | string | any | - | Description of the task. This field will be use in task type : Video, QuizLink, Document, TrainingCourse |
| status | string | draft, publish | - | Status of the task. |
| notificationTemplateId | uuid | any | - | Template Id of the task. You can get the list of notification Templates through Enforcement Template Listing API. |
| task_type | string | Article, Video, QuizLink, Document, TrainingCourse | - | Type of the task. |
| content | string | any | - | Edit the content of the task. Incase of task type Article the content field is required for the article content. |
| link | URL | any | - | Link of the task in case of task type Link. |
| dueDays | number | any | - | Edit the number of days in which a task has to be done. |
| documentId | uuid | any | - | Id of the document in case of the task type Document. You can get the id of the documents through Documnet Listing API |
| trainingCourseTaskListId | uuid | any | - | Id of the course linked in the case of task type Course. You can get the ids of Courses through Courses Listing API |
| videoId | uuid | any | - | You can upload a new video and use an Id of an uploaded Video. In case of uploading a new video a media Id of the video will be used. Upload a video using upload a media API |
Assign a task to Users
Through this API you can assign or unassigned a Task to the users.
HTTP Request
PATCH https://[[API_SERVER_ENDPOINT]]/api/tasks/assign/id
Path Parameters
| Parameter | description |
|---|---|
| id | Id of the Task need to be assigned |
Request Body
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"userIds": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"removeIds": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
]
}
{
"id": "string",
"title": "Fill out timeSheet",
"content": "Fill time sheet at end of day",
"time": 1,
"videoId": "string",
"description": "string",
"link": "string",
"dueDate": "2022-12-15T11:07:19.168Z",
"status": "string",
"assignedUserIds": [
{
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
]
}
| Parameter | Type | Schema Values | Nested Fields | Description |
|---|---|---|---|---|
| userIds | Array<String> | any | - | Ids of the users to which a task should be assigned. You can the list of user ids through User Listing API |
| removeIds | Array<String> | any | - | Ids of the users to which a task should be unassigned. You can the list of user ids through User Listing API |
Delete a Task
Through this API you can delete any Task.
HTTP Request
Delete https://[[API_SERVER_ENDPOINT]]/api/tasks/{id}
Path Parameters
| Parameter | description |
|---|---|
| id | Id of the task need to be deleted |
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
GroupChat
In this section you can find the APIs that are use to access Group Chat listing, Create, Update and Delete a Group Chat.
Get All GroupChats
Through this API you can get all the chat groups.
HTTP Request
GET https://[[API_SERVER_ENDPOINT]]/api/group-chats
Query Parameters
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"per_page" : 5,
"cur_page" : 1,
"group_type" : 'ROOM',
"my_group_chats" : true,
"include_participants" : true
"time" : "2022-10-23T20:32:28.637Z"
}
{
"conversations": [
{
"id": "string",
"groupId": "string",
"title": "string",
"isChannel": true,
"isPrivate": true,
"byRequest": true,
"category": "string",
"image": {}
}
],
"meta": {
"perPage": 0,
"totalPages": 0,
"totalResults": 0,
"curPage": 0,
"nextPage": 0
}
}
| Parameter | Type | Default | Description |
|---|---|---|---|
| cur_page | integer | 1 | A page number within the paginated result set. |
| per_page | integer | 10 | Number of results to return. |
| group_type | string | - | Enter the group type to view the list of group . Group types are: CHAT_GROUP, ROOM. |
| my_group_chats | boolean | - | Mark true if you want to view all the groups that user has been joined. |
| include_participants | boolean | - | Include participants of groups. |
| time | Date | - | List down all the groups created upto the date that has been entered. |
Create a new GroupChat
Through this API you can Create a new GroupChat.
HTTP Request
POST https://[[API_SERVER_ENDPOINT]]/api/group-chats
Request Body
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"isPrivate": true,
"byRequest": true,
"description": "This group is created for testing purpose",
"members": [
{
"id": "6187fcb0-6151-11ec-9294-cfe91ad8177f",
"isAdmin": false
},
{
"id": "fc4ea4d0-58da-11ec-819d-f9796b594a09",
"isAdmin": false
}
],
"fileId": "1bbabc01-b21f-45b4-87db-631bd6a06276",
"title": "new testing group",
"groupType": "CHAT_GROUP",
"category": "Testing"
}
{
"id": "string",
"createdAt": "2022-10-23T20:33:00.826Z",
"updatedAt": "2022-10-23T20:33:00.826Z",
"createdBy": "string",
"updatedBy": "string",
"groupId": "string",
"lastCall": {
"id": "string",
"messageId": {},
"duration": 0,
"startedAt": "2022-10-23T20:33:00.826Z",
"endedAt": "2022-10-23T20:33:00.826Z",
"type": "string",
"status": "string",
"inProgress": true,
"isGroup": true,
"token": {},
"conversationId": {},
"noOfParticipants": 0,
"totalParticipants": 0,
"participants": [
{
"id": "string",
"userId": "string",
"callId": "string",
"agoraId": 0,
"user": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
},
"joinedAt": "2022-10-23T20:33:00.826Z",
"host": true,
"leftAt": {}
}
],
"livestreamConversationId": "string",
"title": {},
"eventForInvitesId": {},
"file": {
"id": "string",
"mime": "string",
"path": "string",
"name": "string",
"processing": {},
"metadata": {},
"size": 0,
"url": "string",
"cdn": "string",
"bucket": "string",
"mp4Urls": [
"string"
],
"hlsUrl": "string",
"dashUrl": "string",
"thumbnail": "string",
"isImage": true,
"isVideo": true,
"isDoc": true,
"createdAt": "2022-10-23T20:33:00.826Z",
"owner": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
},
"userId": "string",
"user": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
},
"scheduledFor": "2022-10-23T20:33:00.826Z",
"record": true,
"event": {
"id": "string",
"createdAt": "2022-10-23T20:33:00.826Z",
"updatedAt": "2022-10-23T20:33:00.826Z",
"createdBy": "string",
"updatedBy": "string",
"title": "string",
"description": "string",
"externalLink": [
{
"title": "string",
"url": "string"
}
],
"isExternalEvent": true,
"conferenceLink": "string",
"location": "string",
"startDateTime": "2022-10-23T20:33:00.826Z",
"endDateTime": "2022-10-23T20:33:00.826Z",
"isVirtual": true,
"eventSource": "string",
"poster": {},
"going": 0,
"myRsvp": "string",
"myCheckin": "2022-10-23T20:33:00.826Z",
"comments": 0,
"tags": [
"string"
],
"reactions": [
"string"
],
"type": {},
"category": {},
"livestream": "string",
"rsvpUsers": [
{
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"phone": "string",
"email": "user@example.com",
"status": "user@example.com",
"invited": "2022-10-23T20:33:00.826Z",
"rsvp": "string"
}
],
"creator": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
},
"externalAttendees": [
"string"
],
"repeatConfig": {
"config": {
"extras": {},
"config": {}
}
},
"repeatId": {}
},
"publicToken": "string"
},
"scheduledCall": {
"id": "string",
"messageId": {},
"duration": 0,
"startedAt": "2022-10-23T20:33:00.826Z",
"endedAt": "2022-10-23T20:33:00.826Z",
"type": "string",
"status": "string",
"inProgress": true,
"isGroup": true,
"token": {},
"conversationId": {},
"noOfParticipants": 0,
"totalParticipants": 0,
"participants": [
{
"id": "string",
"userId": "string",
"callId": "string",
"agoraId": 0,
"user": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
},
"joinedAt": "2022-10-23T20:33:00.826Z",
"host": true,
"leftAt": {}
}
],
"livestreamConversationId": "string",
"title": {},
"eventForInvitesId": {},
"file": {
"id": "string",
"mime": "string",
"path": "string",
"name": "string",
"processing": {},
"metadata": {},
"size": 0,
"url": "string",
"cdn": "string",
"bucket": "string",
"mp4Urls": [
"string"
],
"hlsUrl": "string",
"dashUrl": "string",
"thumbnail": "string",
"isImage": true,
"isVideo": true,
"isDoc": true,
"createdAt": "2022-10-23T20:33:00.826Z",
"owner": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
},
"userId": "string",
"user": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
},
"scheduledFor": "2022-10-23T20:33:00.826Z",
"record": true,
"event": {
"id": "string",
"createdAt": "2022-10-23T20:33:00.826Z",
"updatedAt": "2022-10-23T20:33:00.826Z",
"createdBy": "string",
"updatedBy": "string",
"title": "string",
"description": "string",
"externalLink": [
{
"title": "string",
"url": "string"
}
],
"isExternalEvent": true,
"conferenceLink": "string",
"location": "string",
"startDateTime": "2022-10-23T20:33:00.826Z",
"endDateTime": "2022-10-23T20:33:00.826Z",
"isVirtual": true,
"eventSource": "string",
"poster": {},
"going": 0,
"myRsvp": "string",
"myCheckin": "2022-10-23T20:33:00.826Z",
"comments": 0,
"tags": [
"string"
],
"reactions": [
"string"
],
"type": {},
"category": {},
"livestream": "string",
"rsvpUsers": [
{
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com",
"invited": "2022-10-23T20:33:00.826Z",
"rsvp": "string"
}
],
"creator": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
},
"externalAttendees": [
"string"
],
"repeatConfig": {
"config": {
"extras": {},
"config": {}
}
},
"repeatId": {}
},
"publicToken": "string"
},
"title": "string",
"description": "string",
"image": {
"id": "string",
"mime": "string",
"path": "string",
"name": "string",
"processing": {},
"metadata": {},
"size": 0,
"url": "string",
"cdn": "string",
"bucket": "string",
"mp4Urls": [
"string"
],
"hlsUrl": "string",
"dashUrl": "string",
"thumbnail": "string",
"isImage": true,
"isVideo": true,
"isDoc": true,
"createdAt": "2022-10-23T20:33:00.826Z",
"owner": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
},
"color": "string",
"isChannel": true,
"isPrivate": true,
"byRequest": true,
"type": "string",
"category": "string",
"ticketId": "string",
"newResponseCount": 0,
"initialQuery": "string",
"activeCallId": {},
"expertId": {},
"lastQueryMsg": {},
"videoPreviews": {
"id": "string",
"mime": "string",
"path": "string",
"name": "string",
"processing": {},
"metadata": {},
"size": 0,
"url": "string",
"cdn": "string",
"bucket": "string",
"mp4Urls": [
"string"
],
"hlsUrl": "string",
"dashUrl": "string",
"thumbnail": "string",
"isImage": true,
"isVideo": true,
"isDoc": true,
"createdAt": "2022-10-23T20:33:00.826Z",
"owner": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
},
"participants": [
{
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
],
"muted": true,
"snoozedUntil": "2022-10-23T20:33:00.826Z",
"meta": {},
"reactions": [
"string"
]
}
| Parameter | Type | Schema Values | Nested Fields | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| isPrivate | boolean | true, false |
|
Is a group private or public. | ||||||
| byRequest | boolean | true, false | - | Can other users request to join the group or not. | ||||||
| description | string | any | - | Description of the group. | ||||||
| members | Array | any |
|
Members information of the group. | ||||||
| fileId | uuid | any | - | fileId will be used in case of groupType CHAT_GROUP.It is the id of the group cover media. Upload a cover media using a media API | ||||||
| title | string | any | - | title will be assigned to group in case of group type CHAT_GROUP. | ||||||
| groupType | string | CHAT_GROUP, ROOM | - | Type of the group chat. | ||||||
| category | string | any | - | Categories can be get using List categories API. Assign a category in case of type CHAT_GROUP. |
Update a GroupChat
Through this API you can update a groupchat.
HTTP Request
PATCH https://[[API_SERVER_ENDPOINT]]/api/group-chats/{id}
Path Parameters
| Parameter | description |
|---|---|
| id | Id of the chat group need to be updated |
Request Body
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"title": "new testing group",
"description": "This group is created for testing purpose",
"isPrivate": true,
"newAdmins": [
"6187fcb0-6151-11ec-9294-cfe91ad8177f"
],
"removedAdmins": [
"6187fcb0-6151-11ec-9294-cfe91ad8177f"
],
"fileId": "f5743644-c8ce-4bbe-a9bd-dfdd18dce445",
"category": "Testing"
}
{
"id": "string",
"createdAt": "2022-10-26T07:10:50.376Z",
"updatedAt": "2022-10-26T07:10:50.376Z",
"createdBy": "string",
"updatedBy": "string",
"groupId": "string",
"lastCall": {
"id": "string",
"messageId": {},
"duration": 0,
"startedAt": "2022-10-26T07:10:50.376Z",
"endedAt": "2022-10-26T07:10:50.376Z",
"type": "string",
"status": "string",
"inProgress": true,
"isGroup": true,
"token": {},
"conversationId": {},
"noOfParticipants": 0,
"totalParticipants": 0,
"participants": [
{
"id": "string",
"userId": "string",
"callId": "string",
"agoraId": 0,
"user": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
},
"joinedAt": "2022-10-26T07:10:50.376Z",
"host": true,
"leftAt": {}
}
],
"livestreamConversationId": "string",
"title": {},
"eventForInvitesId": {},
"file": {
"id": "string",
"mime": "string",
"path": "string",
"name": "string",
"processing": {},
"metadata": {},
"size": 0,
"url": "string",
"cdn": "string",
"bucket": "string",
"mp4Urls": [
"string"
],
"hlsUrl": "string",
"dashUrl": "string",
"thumbnail": "string",
"isImage": true,
"isVideo": true,
"isDoc": true,
"createdAt": "2022-10-26T07:10:50.376Z",
"owner": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
},
"userId": "string",
"user": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
},
"scheduledFor": "2022-10-26T07:10:50.376Z",
"record": true,
"event": {
"id": "string",
"createdAt": "2022-10-26T07:10:50.376Z",
"updatedAt": "2022-10-26T07:10:50.376Z",
"createdBy": "string",
"updatedBy": "string",
"title": "string",
"description": "string",
"externalLink": [
{
"title": "string",
"url": "string"
}
],
"isExternalEvent": true,
"conferenceLink": "string",
"location": "string",
"startDateTime": "2022-10-26T07:10:50.376Z",
"endDateTime": "2022-10-26T07:10:50.376Z",
"isVirtual": true,
"eventSource": "string",
"poster": {},
"going": 0,
"myRsvp": "string",
"myCheckin": "2022-10-26T07:10:50.376Z",
"comments": 0,
"tags": [
"string"
],
"reactions": [
"string"
],
"type": {},
"category": {},
"livestream": "string",
"rsvpUsers": [
{
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com",
"invited": "2022-10-26T07:10:50.376Z",
"rsvp": "string"
}
],
"creator": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
},
"externalAttendees": [
"string"
],
"repeatConfig": {
"config": {
"extras": {},
"config": {}
}
},
"repeatId": {}
},
"publicToken": "string"
},
"scheduledCall": {
"id": "string",
"messageId": {},
"duration": 0,
"startedAt": "2022-10-26T07:10:50.376Z",
"endedAt": "2022-10-26T07:10:50.376Z",
"type": "string",
"status": "string",
"inProgress": true,
"isGroup": true,
"token": {},
"conversationId": {},
"noOfParticipants": 0,
"totalParticipants": 0,
"participants": [
{
"id": "string",
"userId": "string",
"callId": "string",
"agoraId": 0,
"user": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
},
"joinedAt": "2022-10-26T07:10:50.376Z",
"host": true,
"leftAt": {}
}
],
"livestreamConversationId": "string",
"title": {},
"eventForInvitesId": {},
"file": {
"id": "string",
"mime": "string",
"path": "string",
"name": "string",
"processing": {},
"metadata": {},
"size": 0,
"url": "string",
"cdn": "string",
"bucket": "string",
"mp4Urls": [
"string"
],
"hlsUrl": "string",
"dashUrl": "string",
"thumbnail": "string",
"isImage": true,
"isVideo": true,
"isDoc": true,
"createdAt": "2022-10-26T07:10:50.376Z",
"owner": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
},
"userId": "string",
"user": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
},
"scheduledFor": "2022-10-26T07:10:50.377Z",
"record": true,
"event": {
"id": "string",
"createdAt": "2022-10-26T07:10:50.377Z",
"updatedAt": "2022-10-26T07:10:50.377Z",
"createdBy": "string",
"updatedBy": "string",
"title": "string",
"description": "string",
"externalLink": [
{
"title": "string",
"url": "string"
}
],
"isExternalEvent": true,
"conferenceLink": "string",
"location": "string",
"startDateTime": "2022-10-26T07:10:50.377Z",
"endDateTime": "2022-10-26T07:10:50.377Z",
"isVirtual": true,
"eventSource": "string",
"poster": {},
"going": 0,
"myRsvp": "string",
"myCheckin": "2022-10-26T07:10:50.377Z",
"comments": 0,
"tags": [
"string"
],
"reactions": [
"string"
],
"type": {},
"category": {},
"livestream": "string",
"rsvpUsers": [
{
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com",
"invited": "2022-10-26T07:10:50.377Z",
"rsvp": "string"
}
],
"creator": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
},
"externalAttendees": [
"string"
],
"repeatConfig": {
"config": {
"extras": {},
"config": {}
}
},
"repeatId": {}
},
"publicToken": "string"
},
"title": "string",
"description": "string",
"image": {
"id": "string",
"mime": "string",
"path": "string",
"name": "string",
"processing": {},
"metadata": {},
"size": 0,
"url": "string",
"cdn": "string",
"bucket": "string",
"mp4Urls": [
"string"
],
"hlsUrl": "string",
"dashUrl": "string",
"thumbnail": "string",
"isImage": true,
"isVideo": true,
"isDoc": true,
"createdAt": "2022-10-26T07:10:50.377Z",
"owner": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
},
"color": "string",
"isChannel": true,
"isPrivate": true,
"byRequest": true,
"type": "string",
"category": "string",
"ticketId": "string",
"newResponseCount": 0,
"initialQuery": "string",
"activeCallId": {},
"expertId": {},
"lastQueryMsg": {},
"videoPreviews": {
"id": "string",
"mime": "string",
"path": "string",
"name": "string",
"processing": {},
"metadata": {},
"size": 0,
"url": "string",
"cdn": "string",
"bucket": "string",
"mp4Urls": [
"string"
],
"hlsUrl": "string",
"dashUrl": "string",
"thumbnail": "string",
"isImage": true,
"isVideo": true,
"isDoc": true,
"createdAt": "2022-10-26T07:10:50.377Z",
"owner": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
},
"participants": [
{
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
],
"muted": true,
"snoozedUntil": "2022-10-26T07:10:50.377Z",
"meta": {},
"reactions": [
"string"
],
"admins": [
"string"
]
}
| Parameter | Type | Schema Values | Nested Fields | Description | |||
|---|---|---|---|---|---|---|---|
| isPrivate | boolean | true, false | -
|
Is a group private or public. | |||
| description | string | any | - | Description of the group. | |||
| newAdmins | Array |
any | - | New group admin Ids. You can get the list of userIds from the User Listing API. | |||
| removedAdmins | Array |
any | - | remove Admins of the group by adding their Ids. You can get the list of userIds from the User Listing API. | |||
| title | string | any | - | title will be assigned to group in case of group type CHAT_GROUP. | |||
| fileId | uuid | any | - | fileId will be used in case of groupType CHAT_GROUP.It is the id of the group cover media. Upload a cover media using a media API | |||
| category | string | any | Categories can be get using List categories API. Change a category in case of type CHAT_GROUP. |
Delete a Group Chat
Through this API you can delete any chat group.
HTTP Request
Delete https://[[API_SERVER_ENDPOINT]]/api/group-chats
Query Parameters
| Parameter | type | description |
|---|---|---|
| id | Array |
Id of the group-chat need to be deleted |
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
Messages
In this section you can find the APIs that are use to send a new message and to create a new meeting in any group or chat.
Send a new Message
Through this API you can send a new message in any group or chat.
HTTP Request
GET https://[[API_SERVER_ENDPOINT]]/api/{conversationId}/messages
Path Parameters
| Parameter | type | description |
|---|---|---|
| conversationId | string | Id of the conversation in which new message will be send. |
Request Body
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"message" : "Hello this is me Adam",
"mention" : ["6187fcb0-6151-11ec-9294-cfe91ad8177f"],
"replyOfMsgId" : "9c5b9d42-e552-49c9-a245-491e70d28866",
"fileId": ["319e142f-e323-453e-aa73-1eac54e4bdc6"]
}
{
"id": "string",
"createdAt": "2022-10-24T05:31:17.783Z",
"updatedAt": "2022-10-24T05:31:17.783Z",
"createdBy": "string",
"updatedBy": "string",
"message": "string",
"isEdited": true,
"replyOfMsgId": "string",
"sender": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
},
"files": {
"files": [
{
"id": "string",
"mime": "string",
"path": "string",
"name": "string",
"processing": {},
"metadata": {},
"size": 0,
"url": "string",
"cdn": "string",
"bucket": "string",
"mp4Urls": [
"string"
],
"hlsUrl": "string",
"dashUrl": "string",
"thumbnail": "string",
"isImage": true,
"isVideo": true,
"isDoc": true,
"createdAt": "2022-10-24T05:31:17.784Z",
"owner": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
}
]
},
"mention": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
},
"reactions": [
{}
],
"linkPreviews": {
"title": "string",
"description": "string",
"image": "string",
"link": "string"
},
"type": 0,
"repliesCount": 0,
"kbExperts": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
},
"kbDocs": {
"answer": "string",
"name": "string",
"path": "string",
"matchConfidenceLevel": "string",
"faqQuestion": "string"
},
"kbFaqs": {
"answer": "string",
"name": "string",
"path": "string",
"matchConfidenceLevel": "string",
"faqQuestion": "string"
},
"video": {
"id": "string",
"createdAt": "2022-10-24T05:31:17.784Z",
"updatedAt": "2022-10-24T05:31:17.784Z",
"createdBy": "string",
"updatedBy": "string",
"title": "string",
"description": "string",
"source": 0,
"videoFileId": "string",
"user": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
},
"thumbnailFileId": "string",
"meta": {}
},
"chat": {
"file": {}
},
"lastQueryMsg": {},
"call": {},
"ticket": {
"id": "string",
"from": "string",
"to": "string",
"response": "string",
"subject": "string",
"snippet": "string",
"conversationId": "string",
"senderName": "string",
"status": "string",
"category": {
"id": "string",
"createdAt": "2022-10-24T05:31:17.784Z",
"updatedAt": "2022-10-24T05:31:17.784Z",
"createdBy": "string",
"updatedBy": "string",
"email": {},
"category": "string"
}
},
"event": {
"id": "string",
"createdAt": "2022-10-24T05:31:17.784Z",
"updatedAt": "2022-10-24T05:31:17.784Z",
"createdBy": "string",
"updatedBy": "string",
"title": "string",
"location": "string",
"startDateTime": "2022-10-24T05:31:17.784Z",
"endDateTime": "2022-10-24T05:31:17.784Z",
"poster": {},
"type": {}
}
}
| Parameter | Type | Default | Description |
|---|---|---|---|
| message | string | - | Text message. |
| mention | Array |
- | Ids of the mention users in a conversation. You can get th Ids of the users through User listing API. |
| replyOfMsgId | uuid | - | Id of the message to which you are replying. |
| fileId | Array |
- | Array of media Ids attached to the message. Upload a different media files using media API |
Create a new meeting in any conversation.
Through this API you can create a new meeting in any group or chat.
HTTP Request
POST https://[[API_SERVER_ENDPOINT]]/api/group-chats
Path Parameters
| Parameter | type | description |
|---|---|---|
| conversationId | string | Id of the conversation in which new message will be send. |
Request Body
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"title": "new Meeting",
"userIds": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"startDateTime": "2022-09-14T07:58:00.000Z",
"endDateTime": "2022-09-14T08:58:00.000Z",
"posterId": "c2b78442-6cb8-4f49-9a0b-53cdb8d8c95b",
"duration": 0
}
{
"id": "string",
"createdAt": "2022-10-24T06:02:15.390Z",
"updatedAt": "2022-10-24T06:02:15.390Z",
"createdBy": "string",
"updatedBy": "string",
"title": "string",
"description": "string",
"externalLink": [
{
"title": "string",
"url": "string"
}
],
"isExternalEvent": true,
"conferenceLink": "string",
"location": "string",
"startDateTime": "2022-10-24T06:02:15.391Z",
"endDateTime": "2022-10-24T06:02:15.391Z",
"isVirtual": true,
"eventSource": "string",
"poster": {},
"going": 0,
"myRsvp": "string",
"myCheckin": "2022-10-24T06:02:15.391Z",
"comments": 0,
"tags": [
"string"
],
"reactions": [
"string"
],
"type": {},
"category": {},
"livestream": {
"id": "string",
"messageId": {},
"duration": 0,
"startedAt": "2022-10-24T06:02:15.391Z",
"endedAt": "2022-10-24T06:02:15.391Z",
"type": "string",
"status": "string",
"inProgress": true,
"isGroup": true,
"token": {},
"conversationId": {},
"noOfParticipants": 0,
"totalParticipants": 0,
"participants": [
{
"id": "string",
"userId": "string",
"callId": "string",
"agoraId": 0,
"user": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
},
"joinedAt": "2022-10-24T06:02:15.391Z",
"host": true,
"leftAt": {}
}
],
"livestreamConversationId": "string",
"title": {},
"eventForInvitesId": {},
"file": {
"id": "string",
"mime": "string",
"path": "string",
"name": "string",
"processing": {},
"metadata": {},
"size": 0,
"url": "string",
"cdn": "string",
"bucket": "string",
"mp4Urls": [
"string"
],
"hlsUrl": "string",
"dashUrl": "string",
"thumbnail": "string",
"isImage": true,
"isVideo": true,
"isDoc": true,
"createdAt": "2022-10-24T06:02:15.391Z",
"owner": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
},
"userId": "string",
"user": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"email": "user@example.com",
"status": "user@example.com"
},
"scheduledFor": "2022-10-24T06:02:15.391Z",
"record": true,
"event": "string",
"publicToken": "string"
},
"rsvpUsers": [
{
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com",
"invited": "2022-10-24T06:02:15.391Z",
"rsvp": "string"
}
],
"creator": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
},
"externalAttendees": [
"string"
],
"repeatConfig": {
"config": {
"extras": {},
"config": {}
}
},
"repeatId": {}
}
| Parameter | Type | Schema Values | Nested Fields | Description |
|---|---|---|---|---|
| title | string | any | Title of the meeting. | |
| userIds | Array |
any | - | Ids of the meeting participants. You can get the user Ids through User Listing API. |
| startDateTime | Date | any | - | Starting time of a meeting. |
| endDateTime | Date | any | Ending time of a meeting. | |
| duration | integer | any | - | Duration of a meeting. |
Departments
In this section you can find the APIs that are use to access Department listing, Create, Update, Update Department Members, Add Department Heads and Delete a Department.
Get All Departments
Through this API you can get all the list of a Organization's Department.
GET https://[[API_SERVER_ENDPOINT]]/api/departments
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
cur_page: 1,
per_page: 10
}
{
"departments": [
{
"id": "string",
"name": "string",
"memberCount": 0,
"admins": [
{
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
]
}
],
"meta": {
"perPage": 0,
"totalPages": 0,
"totalResults": 0,
"curPage": 0,
"nextPage": 0
}
}
Query Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| cur_page | integer | 1 | A page number within the paginated result set. |
| per_page | integer | 10 | Number of results to return. |
Create a Department
Through this API you can create a new Department. There should be atleast one department Head for a specific department
HTTP Request
POST https://[[API_SERVER_ENDPOINT]]/api/departments
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"members": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"existingDept": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"isDepartmentHead": false
}
],
"name": "Management"
}
{
"id": "string",
"createdAt": "2022-11-28T05:52:23.167Z",
"updatedAt": "2022-11-28T05:52:23.167Z",
"createdBy": "string",
"updatedBy": "string",
"orgId": "string",
"type": "string",
"name": "Management"
}
| Parameter | Type | Schema Values | Nested Fields | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| members | Array | any |
|
|||||||||||||
| name | string | any | - | Name of the department. |
Update Department Head
Through this API you can add or remove department's Head
HTTP Request
PATCH https://[[API_SERVER_ENDPOINT]]/api/departments/{id}/admin
Path Parameters
| Parameter | description |
|---|---|
| id | Id of the Department |
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"remove": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"add": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"isAdmin": false,
"existingDept": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"isDepartmentHead": false
}
]
}
{
"id":"string",
"createdAt":"2022-10-20T12:46:59.074Z",
"updatedAt":"2022-10-20T12:46:59.074Z",
"createdBy":"string",
"updatedBy":"string",
"type":"string",
"orgId":"string",
"name":"Management"
}
| Parameter | Type | Schema Values | Nested Fields | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| add | Array | any |
|
||||||||||||||||
| remove | uuid | any | - | Id of the user that should be removed from Department's Head list. |
Update Department Members
Through this API you can add or remove members of the department
HTTP Request
POST https://[[API_SERVER_ENDPOINT]]/api/departments/{id}/members
Path Parameters
| Parameter | description |
|---|---|
| id | Id of the Department |
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"addMembers": [
{
"id": "6301fd00-6216-11ec-9294-cfe91ad8177f",
"isAdmin": false,
"existingDept": "2886a908-42b4-4612-b096-eac24f229b5b",
"isDepartmentHead" : false
}
],
"removeMembers": [
"6301fd00-6216-11ec-9294-cfe91ad8177f"
]
}
{
"id": "string",
"createdAt": "2022-12-17T08:11:41.769Z",
"updatedAt": "2022-12-17T08:11:41.769Z",
"createdBy": "string",
"updatedBy": "string",
"orgId": "string",
"type": "string",
"name": "Management",
"departmentHeads": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"members": [
{
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
]
}
| Parameter | Type | Schema Values | Nested Fields | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| addMembers | Array | any |
|
||||||||||||||||
| removeMembers | Array | any | - | Id of the users that should be removed from the department. |
Get Department Members
Through this API you can get all the members of a specific department
HTTP Request
GET https://[[API_SERVER_ENDPOINT]]/api/departments/{id}/members
Path Parameters
| Parameter | description |
|---|---|
| id | Id of the Department |
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"id": "string",
"createdAt": "2022-12-17T08:12:23.698Z",
"updatedAt": "2022-12-17T08:12:23.698Z",
"createdBy": "string",
"updatedBy": "string",
"orgId": "string",
"type": "string",
"name": "Management",
"departmentHeads": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"members": [
{
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
]
}
| Parameter | Type | Schema Values | Nested Fields | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| addMembers | Array | any |
|
||||||||||||||||
| removeMembers | Array | any | - | Id of the users that should be removed from the department. |
Update a Department
Through this API you can update any department.
HTTP Request
PATCH https://[[API_SERVER_ENDPOINT]]/api/departments/{id}
Path Parameters
| Parameter | description |
|---|---|
| id | Id of the Department need to be updated |
Request Body
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"name": "Management"
}
{
"id":"string",
"createdAt":"2022-10-20T12:46:59.074Z",
"updatedAt":"2022-10-20T12:46:59.074Z",
"createdBy":"string",
"updatedBy":"string",
"type":"string",
"orgId":"string",
"name":"Management"
}
| Parameter | Type | Schema Values | Nested Fields | Description |
|---|---|---|---|---|
| name | string | any | Updated name of the department |
Delete a Department
Through this API you can delete any Department.
HTTP Request
Delete https://[[API_SERVER_ENDPOINT]]/api/departments/{id}
Path Parameters
| Parameter | description |
|---|---|
| id | Id of a Department need to be deleted |
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
Locations
In this section you can find the APIs that are use to access Location listing, Create, Update, Update Location Members and Delete a Location.
Get All Locations
Through this API you can get all the list of a Organization's Locations.
GET https://[[API_SERVER_ENDPOINT]]/api/locations
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
cur_page: 1,
per_page: 10
}
{
"locations": [
{
"id": "string",
"createdAt": "2022-11-25T12:24:36.296Z",
"updatedAt": "2022-11-25T12:24:36.296Z",
"createdBy": "string",
"updatedBy": "string",
"name": "string",
"orgId": "afdcc332-51a0-11eb-b540-537816f1bbe5",
"memberCount": 2
}
],
"meta": {
"perPage": 0,
"totalPages": 0,
"totalResults": 0,
"curPage": 0,
"nextPage": 0
}
}
Query Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| cur_page | integer | 1 | A page number within the paginated result set. |
| per_page | integer | 10 | Number of results to return. |
Create a Location
Through this API you can create a new Department. There should be atleast one department Head for a specific department
HTTP Request
POST https://[[API_SERVER_ENDPOINT]]/api/departments
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"name": "Berlin"
}
{
"addedBy": "172fa58d-7933-45a6-a905-b06770f2224c",
"name": "California",
"orgId": "172fa58d-7933-45a6-a905-b06770f2224c"
}
| Parameter | Type | Schema Values | Nested Fields | Description |
|---|---|---|---|---|
| name | string | any | - | Name of the Location. |
Update Location Members
Through this API you can add or remove members of the location
HTTP Request
POST https://[[API_SERVER_ENDPOINT]]/api/locations/{id}/members
Path Parameters
| Parameter | description |
|---|---|
| id | Id of the Location |
{
"addMembers": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"removeMembers": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
]
}
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"id": "string",
"createdAt": "2022-12-17T08:13:21.760Z",
"updatedAt": "2022-12-17T08:13:21.760Z",
"createdBy": "string",
"updatedBy": "string",
"name": "string",
"orgId": "afdcc332-51a0-11eb-b540-537816f1bbe5",
"members": [
{
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
]
}
| Parameter | Type | Schema Values | Description |
|---|---|---|---|
| addMembers | Array | any | - |
| removeMembers | Array | any | Ids of the users that should be removed from the location. |
Get Location Members
Through this API you can get all the members of a specific location
HTTP Request
GET https://[[API_SERVER_ENDPOINT]]/api/locations/{id}/members
Path Parameters
| Parameter | description |
|---|---|
| id | Id of the Department |
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"id": "string",
"createdAt": "2022-12-17T08:13:21.760Z",
"updatedAt": "2022-12-17T08:13:21.760Z",
"createdBy": "string",
"updatedBy": "string",
"name": "string",
"orgId": "afdcc332-51a0-11eb-b540-537816f1bbe5",
"members": [
{
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
]
}
Update a Location
Through this API you can update any location.
HTTP Request
PATCH https://[[API_SERVER_ENDPOINT]]/api/locations/{id}
Path Parameters
| Parameter | description |
|---|---|
| id | Id of the Location need to be updated |
Request Body
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"name": "New Jersey"
}
{
"id": "string",
"createdAt": "2022-11-25T12:41:08.001Z",
"updatedAt": "2022-11-25T12:41:08.001Z",
"createdBy": "string",
"updatedBy": "string",
"name": "string",
"orgId": "afdcc332-51a0-11eb-b540-537816f1bbe5"
}
| Parameter | Type | Schema Values | Nested Fields | Description |
|---|---|---|---|---|
| name | string | any | Updated name of the Location |
Delete a Location
Through this API you can delete any Location.
HTTP Request
Delete https://[[API_SERVER_ENDPOINT]]/api/locations/{id}
Path Parameters
| Parameter | description |
|---|---|
| id | Id of a Location need to be deleted |
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
Security Groups
In this section you can find the API that is use to access Security Groups listing of an organization.
Get All Security Groups
Through this API you can get the list of Security Groups of a User's Organization.
GET https://[[API_SERVER_ENDPOINT]]/api/security_groups
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
cur_page: 1,
per_page: 10
}
{
"groups": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "string",
"memberCount": 0
}
],
"meta": {
"perPage": 0,
"totalPages": 0,
"totalResults": 0,
"curPage": 0,
"nextPage": 0
}
}
Query Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| cur_page | integer | 1 | A page number within the paginated result set. |
| per_page | integer | 10 | Number of results to return. |
Add users to the SecurityGroup
Through this API you can add the users in specific security groups.
POST https://[[API_SERVER_ENDPOINT]]/api/security_groups/{groupId}/members}
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"ids": [
"6187fcb0-6151-11ec-9294-cfe91ad8177f","8a243770-6150-11ec-9294-cfe91ad8177f"
]
}
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| groupId | uuid | Id of the security group. You can get the list of security groups using Security Groups Listing API |
RequestBody
| Parameter | Type | Description |
|---|---|---|
| ids | Array<uuid> | Id of users. You can get the list of users using User Listing API |
Remove users from the SecurityGroup
Through this API you can remove the users in specific security groups.
DELETE https://[[API_SERVER_ENDPOINT]]/api/security_groups/{groupId}/members}
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"ids": [
"6187fcb0-6151-11ec-9294-cfe91ad8177f","8a243770-6150-11ec-9294-cfe91ad8177f"
]
}
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| groupId | uuid | Id of the security group. You can get the list of security groups using Security Groups Listing API |
RequestBody
| Parameter | Type | Description |
|---|---|---|
| ids | Array<uuid> | Id of users. You can get the list of users using User Listing API |
SSO
In this section you can find the APIs that are use to access SSO listing and create a SSO
Get all SSOs
Through this API you can get the list of a SSOs
HTTP Request
GET https://[[API_SERVER_ENDPOINT]]/api/sso
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"manage": false,
"location": "9aa53819-f4f8-4c59-ba74-56aae6b604cc",
"department": "d3e47d0d-5f6d-49d2-9b7b-21f837291008"
}
[
{
"id": "string",
"createdAt": "2022-12-08T11:56:33.870Z",
"updatedAt": "2022-12-08T11:56:33.870Z",
"createdBy": "string",
"updatedBy": "string",
"authorizationURI": "{{redirect_uri}}/?code=<authorization_token",
"tokenURI": "https://api.example.io/oauth/token",
"refreshURI": "https://api.example.io/oauth/token/refresh",
"loginURL": "string",
"orgId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"locationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"departmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"order": 0,
"file": {
"id": "string",
"mime": "string",
"path": "string",
"name": "string",
"processing": {},
"metadata": {},
"size": 0,
"url": "string",
"cdn": "string",
"bucket": "string",
"mp4Urls": [
"string"
],
"hlsUrl": "string",
"dashUrl": "string",
"thumbnail": "string",
"isImage": true,
"isVideo": true,
"isDoc": true,
"createdAt": "2022-12-08T11:56:33.870Z",
"owner": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
},
"user": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
},
"link": "https://api.example.io",
"type": "QUICK_LINK"
}
]
Query Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| manage | boolean | false | True if user want to view list of admin level SSOs. |
| location | uuid | - | Filter SSOs by specifying the location id. You can find the list of locations by using the Location listing API. |
| department | uuid | - | Filter SSos by specifying the department id. You can find the list of departments by using the Department listing API. |
Create a SSO
Through this API you can create a new SSO at admin, user, department or at location level
HTTP Request
POST https://[[API_SERVER_ENDPOINT]]/api/sso
Query Parameters
| Parameter | description |
|---|---|
| manage | A boolean parameter. It should be if user wants to create a SSO at admin level. |
Request Body
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"type": "QUICK_LINK",
"name": "Salesforce",
"authorizationURI": "{{redirect_uri}}/?code=<authorization_token",
"tokenURI": "https://api.example.io/oauth/token",
"refreshURI": "https://api.example.io/oauth/token/refresh",
"loginURL": "https://api.example.io/oauth/login?token={{access_token}}",
"order": 1,
"fileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"departmentId": "1243134a-56b2-11ed-9b6a-0242ac120002",
"locationId": "1243134a-56b2-11ed-9b6a-0242ac120002",
"link": "https://api.example.io"
}
{
"id": "string",
"createdAt": "2022-12-08T11:54:51.367Z",
"updatedAt": "2022-12-08T11:54:51.367Z",
"createdBy": "string",
"updatedBy": "string",
"authorizationURI": "{{redirect_uri}}/?code=<authorization_token",
"tokenURI": "https://api.example.io/oauth/token",
"refreshURI": "https://api.example.io/oauth/token/refresh",
"loginURL": "string",
"orgId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"locationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"departmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"order": 0,
"file": {
"id": "string",
"mime": "string",
"path": "string",
"name": "string",
"processing": {},
"metadata": {},
"size": 0,
"url": "string",
"cdn": "string",
"bucket": "string",
"mp4Urls": [
"string"
],
"hlsUrl": "string",
"dashUrl": "string",
"thumbnail": "string",
"isImage": true,
"isVideo": true,
"isDoc": true,
"createdAt": "2022-12-08T11:54:51.367Z",
"owner": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
}
},
"user": {
"id": "string",
"firstName": "string",
"lastName": "string",
"picture": {},
"cover": {},
"color": "string",
"online": true,
"availability": 1,
"designation": {},
"department": {},
"availabilityStatusText": "string",
"phone": "string",
"email": "user@example.com",
"status": "user@example.com"
},
"link": "https://api.example.io",
"type": "QUICK_LINK"
}
| Parameter | Type | Schema Values | Nested Fields | Description |
|---|---|---|---|---|
| type | string | QUICK_LINK, SSO | - | Type of the SSO. |
| name | string | any | - | Name of the SSO. |
| authorizationURI | URI | any | - | Authorization URI OF sso. |
| tokenURI | URI | any | - | This will allow you to generate new token using authorization Code. |
| refreshURI | URI | any | - | This will allow you to generate new token using refresh token. |
| loginURL | URL | any | - | This will allow you to log into your account. |
| order | number | any | - | Specify an order of the SSO. |
| fileId | uuid | any | - | Media Id of SSO Image. Upload a media file using a media API |
| departmentId | uuid | any | - | An optional field. It is an id of a department. It should be given when the user wants to create an SSO against the specific department.You can find the list of departments by using the Department listing API. |
| locationId | uuid | any | - | An optional field. It is an id of a location. It should be given when the user wants to create an SSO against the specific location.You can find the list of locations by using the Location listing API. |
| link | URL | any | - | Link of the sso. It will be required in case of type 'QUICK_LINK'. |
Media
Welcome to the Media API! You can use our API to upload any media used in different modules.
Upload a Media
Through this API you can get the fileId and signedRequest Object that has following fields:
- ACL
- Content-Type
- Key
- Policy
- X-Amz-Algorithm
- X-Amz-Credential
- X-Amz-Date
- X-Amz-Signature
- bucket
- url
You will hit the SignedRequest's url through any API platform and made a POST request with body type FormData and attach the mediafile with the remaining above mentioned fields.
HTTP Request
GET https://[[API_SERVER_ENDPOINT]]/api/media
Query Parameters
{
"X-API-KEY" : "AUTHORIZATION KEY"
}
{
"mime":"video/mp4",
"name":"5 Second Countdown Intro video YouTube.mp4",
"moduleCode":1
}
{
"fileId": "fdca3aa5-363c-4400-b158-bd59aa168f19",
"signedRequest": {
"url": "https:aHR0cHM6Ly9zMy51cy13ZXN0LTIuYW1hem9uYXdzLmNvbS9ib3Nzc2RldnZpZGVvZmlsZWhhbmRsZXItc291cmNlLTFkdTJ5MnhtY2UxZ2Q=",
"fields": {
"Key": "ZGV2ZWxvcG1lbnQvby1jNzk3NGVmMC01OGMwLTExZWMtODE5ZC1mOTc5NmI1OTRhMDkvbS0xL3UtNjMwMWZkMDAtNjIxNi0xMWVjLTkyOTQtY2ZlOTFhZDgxNzdmLzQ0YTJmNjFkYzVjNWZjY2U2ZmI5YmQ3NWFjNTg1MWFmNDA4YWRiNzgubXA0",
"Content-Type": "video/mp4",
"ACL": "public-read",
"bucket": "Ym9zc3NkZXZ2aWRlb2ZpbGVoYW5kbGVyLXNvdXJjZS0xZHUyeTJ4bWNlMWdk",
"X-Amz-Algorithm": "AWS4-HMAC-SHA256",
"X-Amz-Credential": "access_key/YYYYMMDD/region/service/aws4_request",
"X-Amz-Date": "20221219T094258Z",
"Policy": "pMWGRsYzNRdE1pOXpNeTloZDNNMFgzSmxjWFZsYzNRaWZTeDdJbGd0UVcxNkxVUmhkR1VpT2lJeU1ESXlNVEl4T1ZRd09UUXlOVGhhSW4xZGZRPT0=",
"X-Amz-Signature": "hex-encodedsignature"
}
},
"url": "https://Ym9zc3NkZXZ2aWRlb2ZpbGVoYW5kbGVyLXNvdXJjZS0xZHUyeTJ4bWNlMWdkLnMzLmFtYXpvbmF3cy5jb20vZGV2ZWxvcG1lbnQvby1jNzk3NGVmMC01OGMwLTExZWMtODE5ZC1mOTc5NmI1OTRhMDkvbS0xLw==u-6301fd00-6216-11ec-9294-cfe91ad8177f/44a2f61dc5c5fcce6fb9bd75ac5851af408adb78.mp4"
}
| Parameter | Type | Description |
|---|---|---|
| mime* | string | Valid mime type according to the media type. At the end of this section you can find the basic mime types against different media types. |
| name* | string | Name of the file. |
| moduleCode* | integer | Enter the code of the module against which you need to upload a media. Each module have a specific code. You can get the list of codes using ModuleCodes listing API. |
| Media | mime Type |
|---|---|
| image |
|
| video |
|
| document |
|
Errors
The API Access uses the following error codes:
| Error Code | Meaning |
|---|---|
| 400 | Bad Request -- Your request is invalid. |
| 401 | Unauthorized -- Your API key is wrong. |
| 403 | Forbidden -- The requested content is hidden for administrators only. |
| 404 | Not Found -- The specified content could not be found. |
| 500 | Internal Server Error -- We had a problem with our server. Try again later. |
| 503 | Service Unavailable -- We're temporarily offline for maintenance. Please try again later. |