NAV
Request Headers Request Body Response

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

Copy to Clipboard
{
  "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.

Login Window

2: Click on your profile picture shown on the top right of your screen > Click Manage

Manage Window

3: Scroll to the left until you see the 3 upside down dots against any user record. Click this icon and Select Api Access

Manage User Window

4: Regenrate new API access token and use this to get authorize yourself to the API Access endpoints.

Token Window

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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
Parameter Type Schema Values Description
email email 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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
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 
Copy to Clipboard
{
  "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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}

Bulk Delete User

Through this API you can delete any User.

HTTP Request

Delete https://[[API_SERVER_ENDPOINT]]/api/users/bulk-delete

Request Body

Parameter Type Description
id Array<String> Users id that need to be deleted 

Copy to Clipboard
{
  "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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
Parameter Type Nested Fields Description
name string - Name of an organization.
admin Object
Property Type Description
firstName string First name of an admin
lastName string Last name of an admin
email Email Email id of an admin
auth Object
Property Values
method internal, ldap
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} 

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}

Path Parameters

Parameter description
id Id of an organization need to be updated
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
Property Type
street1 string
street2 string
citystring
statestring
zipstring
email Email 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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
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.
  • a: Recent
  • b: Most Reacted
  • c: Most Commented

Create a Post

Through this API you can create a new Post.

HTTP Request

POST https://[[API_SERVER_ENDPOINT]]/api/posts

Request Body

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
Parameter Type Schema Values Nested Fields Description
permissions string any
Property Type
public boolean
friends boolean
onlyMe boolean
team boolean
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
textAddressstring
coordinates
lat string
long string
 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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
Parameter Type Schema Values Nested Fields Description
permissions string any
Property Type
public boolean
friends boolean
onlyMe boolean
team boolean
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
textAddressstring
coordinates
lat string
long string
 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 
Copy to Clipboard
{
  "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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
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.
  • a: Recent
  • b: Most Reacted
  • c: Most Commented

Create a News

Through this API you can create a new News.

HTTP Request

POST https://[[API_SERVER_ENDPOINT]]/api/news

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
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
  • lat: string
  • long: string
 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

`

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
`

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
  • lat: string
  • long: string
 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 
Copy to Clipboard
{
  "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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
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.
  • POST
  • LIVESTREAM
  • EVENT
  • FAQ
  • COURSE
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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}

Request Body

Parameter Type Schema Values Nested Fields Description
permissions string any
Property Type
public boolean
friends boolean
onlyMe boolean
team boolean
usersArray<uuid>
 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
title string
urlURL
 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 -
config
type'frequency'
frequency'string'-Choose the frequency value from the list shown below
ValueTitle
86400'daily'
604800'weekly'
1209600'biWeekly'
monthly'monthly'
ends
config
type"on"
dateDate
 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. 
Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
Parameter Type Schema Values Nested Fields Description
permissions string any
Property Type
public boolean
friends boolean
onlyMe boolean
team boolean
usersArray<uuid>
 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
title string
urlURL
 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
  • POST
  • LIVESTREAM
  • EVENT
  • FAQ
  • COURSE
 - 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 -
config
type'frequency'
frequency'string'-Choose the frequency value from the list shown below
ValueTitle
86400'daily'
604800'weekly'
1209600'biWeekly'
monthly'monthly'
ends
config
type"on"
dateDate
 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. 
Copy to Clipboard
{
  "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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}

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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
Parameter Type Schema Values Nested Fields Description
permissions string any
Property Type
public boolean
friends boolean
onlyMe boolean
team boolean
usersArray<uuid>
 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 -
videoURL string
 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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}

`

`

Parameter Type Schema Values Nested Fields Description
permissions string any
Property Type
public boolean
friends boolean
onlyMe boolean
team boolean
usersArray<uuid>
 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 
Copy to Clipboard
{
  "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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}

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
  • all_photos
  • friends_photos
  • only_me_photos
  • tagged_photos
  • team_photos
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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
Parameter Type Schema Values Nested Fields Description
permissions string any
Property Type
public boolean
friends boolean
onlyMe boolean
team boolean
usersArray<uuid>
 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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
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 
Copy to Clipboard
{
  "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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
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. 
Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}

Request Body

Parameter Type Schema Values Nested Fields Description
permissions string any
Property Type
public boolean
friends boolean
onlyMe boolean
team boolean
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. 
Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
Parameter Type Schema Values Nested Fields Description
kb object -
name string
newOwnerIds Array<string>
removeOwnerIdsArray<string>
expiry Date
tags Array<string>
categorystring
linkstring
permissions 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 
Copy to Clipboard
{
  "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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
Parameter Type Schema Values Nested Fields Description
permissions string any
Property Type
public boolean
team boolean
friends boolean
onlyMe boolean
users Array<uuid>
Permissions determines the visibility of the post.
kb object -
name string
newOwnerIds Array<string>
removeOwnerIds Array<string>
expiry Date
category string
link string
Contains the basic information of the FAQ
qas Array any
question * string
answer * string
description string
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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
Parameter Type Schema Values Nested Fields Description
permissions string any
Property Type
public boolean
team boolean
friends boolean
onlyMe boolean
users Array<uuid>
Permissions determines the visibility of the post.
kb object -
name string
newOwnerIds Array<string>
removeOwnerIds Array<string>
expiry Date
category string
link string
Enter the information about the FAQ name, ownerIds, tags , FAQ expiry and category.
qas Array any
question * string
answer * string
description string
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 
Copy to Clipboard
{
  "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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}

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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}

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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
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 
Copy to Clipboard
{
  "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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
`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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
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 
Copy to Clipboard
{
  "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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
Parameter Type Schema Values Nested Fields Description
isPrivate boolean true, false
Property Type Description
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
id uuid Id of the user. You can get the list of users through User Listing API
isAdmin boolean Is the user admin of the group or not
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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
Parameter Type Schema Values Nested Fields Description
isPrivate boolean true, false -
Property Type Description
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 
Copy to Clipboard
{
  "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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}

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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
Parameter Type Schema Values Nested Fields Description
members Array any
Property Type Description
id uuid User Id
existing Department uuid UUID of the user's existing Department.
isDepartmentHead boolean Is the user already head of anyother department
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 
Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
Parameter Type Schema Values Nested Fields Description
add Array any
Property Type Description
id uuid User Id
isAdmin boolean Is User will be the admin of the department. It should be true while creating a new department
existing Department uuid UUID of the user's existing Department.
isDepartmentHead boolean Is the user already head of anyother department
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 
Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
Parameter Type Schema Values Nested Fields Description
addMembers Array any
Property Type Description
id uuid User Id
isAdmin boolean Is User will be the admin of the department. It should be true while creating a new department
existing Department uuid UUID of the user's existing Department.
isDepartmentHead boolean Is the user already head of anyother department
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 
Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
Parameter Type Schema Values Nested Fields Description
addMembers Array any
Property Type Description
id uuid User Id
isAdmin boolean Is User will be the admin of the department. It should be true while creating a new department
existing Department uuid UUID of the user's existing Department.
isDepartmentHead boolean Is the user already head of anyother department
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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
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 
Copy to Clipboard
{
  "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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}

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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
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 
Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
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 
Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}


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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
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 
Copy to Clipboard
{
  "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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}

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}

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}

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}

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}

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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}

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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
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:

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

Copy to Clipboard
{
  "X-API-KEY" : "AUTHORIZATION KEY"
}
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
  • image/jpeg
  • image/png
video
  • video/mp4
document
  • text/plain
  • application/pdf
  • application/msword
  • application/vnd.openxmlformats-officedocument.wordprocessingml.document
  • application/vnd.ms-powerpoint
  • application/vnd.openxmlformats-officedocument.presentationml.presentation

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.
Request Headers Request Body Response