Introduction
Engagedly is a cloud based new age Performance Management Software that redefines performance appraisals by simplifying and incorporating elements of employee engagement into the performance review process.
Engagedly API are designed to be REST (Representational State Transfer) APIs. These ‘RESTful’ APIs allows operations such as reading, modifying, adding or deleting data from your Engagedly Instance.
Getting Started
Authentication
Each call to the API is authenticated by including your client key and secret key in the request. Client key and secret key are obtained and managed through Engagedly Portal. Please read the instructions below in order to obtained your client key and secret key.
Please note that you need to have Site Administrator account to obtain the keys and these keys will carry the permissions of the user who has generated them.
Obtaining your client key and secret key
You can obtain your client key and secret key from settings page after login into Engagedly as Site Administrator. You can generate the client key and secret key after navigating to Integrations and then to Engagedly API.
Authenticating the request
To authenticate the API call, client key and secret key needs to be included as part of the header.
Sample Request
curl "https://api.engagedly.com/beta/users"
-H "ClientKey: xxxxxxxxxxxxxx"
-H "SecretKey: xxxxxxxxxxxxxx"
Requests
All Engagedly APIs require specifying an API version in the request URL. The most current version of the API is beta. API endpoint for the current beta version is
https://api.engagedly.com/beta/
JSON Bodies
All POST, PUT, PATCH requests are JSON encoded and must have have content type of application/json, or the API will return a 415 Unsupported Media Type status code.
$ curl https://api.engagedly.com/beta/users/b62167d0-2718-4e45-9721-27535991becf \
-X PUT \
-H 'Content-Type: application/json' \
-H "ClientKey: xxxxxxxxxxxxxx" \
-H "SecretKey: xxxxxxxxxxxxxx" \
-d '{"first_name":"John"}'
API Commands
Engagedly APIs are plain JSON over HTTP and use the following HTTP verbs:
| COMMAND | PURPOSE |
|---|---|
| GET | To get one or more entities |
| POST | To create an entity |
| PUT | To update an entity |
| DELETE | To delete an entity |
Responses
All response bodies are JSON encoded.
A single resource is represented as a JSON object. A collection of resources is represented as a JSON array of objects
Blank fields will be included as a null instead of ommited. If the field is an array, it will be included as an empty array i.e. [].
Timestamps are in UTC and formatted as ISO8601.
HTTP Status Codes
Engagedly uses conventional HTTP status codes to indicate success or failure of an API call. In general, status codes in the 2xx range means success, 4xx range means there was an error in the provided information, and those in the 5xx range indicates server side errors. Commonly used HTTP status codes are listed below.
| CODE | DESCRIPTION |
|---|---|
| 200 | OK – Everything worked as expected. |
| 201 | Created – The request was a success and one or more resources have been created. |
| 204 | No Content - Request succeeded, but no response body. |
| 400 | Bad Request – The request cannot be performed. Usually because of malformed parameter or missing parameter. |
| 401 | Unauthorized – Request was rejected because of invalid AuthToken. |
| 402 | Request Failed – The parameters were valid but the request failed. |
| 403 | Forbidden – The user does not have enough permission or possibly not an user of the respective organization to access the resource. |
| 404 | Not Found – The URL you’ve sent is wrong. It’s possible that the resource you’ve requested has been moved to another URL. |
| 405 | Method Not Allowed – The requested resource does not support the HTTP method used. |
| 406 | Not Acceptable – The requested response type is not supported by the client. |
| 409 | Conflict – The request conflicts with another request (perhaps due to using the same idempotent key). |
| 415 | Unsupported Media Type - POST/PUT/PATCH request occurred without a application/json content type. |
| 422 | Unprocessable Entry - A request to modify or create a resource failed due to a validation error. |
| 429 | Too Many Requests – Too many requests within a certain time frame. |
| 500 | Server Errors – Something went wrong on Engagedly’s end. |
Error Response
In addition to the HTTP status code, most errors will also return a response body that contains more information for debugging the error.
Error Type
| TYPE | DESCRIPTION |
|---|---|
| api_connection_error | Could not connect to Engagedly API |
| authentication_error | Could not authenticate properly |
| invalid_request_error | Invalid request errors arise when your request has invalid parameters. |
| validation_error | Errors triggered by our client-side libraries when failing to validate fields (e.g., when a card number or expiration date is invalid or incomplete) |
Error Codes
Sample Error Response
{
"error_type": "validation_error",
"errors":[
{
"field":"name",
"message":"Mandatory attribute missing",
"code":"missing_field"
},
{
"field":"code",
"message":"Value already existing",
"code":"duplicate_value"
}
]
}
Pagination
Most of the API responses that returns the list of objects are paginated. The parameters that control the pagination are ‘page’ and ‘size’, indicating the page number and the items per page values. Within the response, a pagination attribute will be set and will contain the provided ‘page’ and ‘size’ along with ‘has_more’ and ‘record_count’ indicating whether there are more items that can be fetched and total number of records.
The page number starts with 1 and by default the number of records returned are 25. The maximum number of records (size) that can be returned is 50.
Users
List all users
GET https://api.engagedly.com/beta/users
URL Parameters for extra information
| Parameter | Description |
|---|---|
| include | primary_reporter,direct_reports |
| filter based on an email |
Sample Request
GET https://api.engagedly.com/beta/users
Sample Request with extra information
GET https://api.engagedly.com/beta/users?include=primary_reporter,direct_reports
Sample Response
200 OK
content-type: application/json
{
"success": true,
"pagination": {
"page": 1,
"size": 30,
"has_more": false,
"total_records": 1
},
"data": [
{
"id": "b62167d0-2718-4e45-9721-27535991becf",
"name": "Adam Smith",
"status": "Active",
"email": "adam.smith@teamyogi.com",
"first_name": "Adam",
"middle_name": null,
"last_name": "Smith",
"employee_id": "E007",
"display_picture": {
"medium": "https://social.engagedly.com/uploads/picture/file/9634/reduced_Denzel.jpg",
"small": "https://social.engagedly.com/uploads/picture/file/9634/small_Denzel.jpg"
},
"job_title": {
"id": "261",
"name": "CEO"
},
"location": {
"id": "11",
"name": "United States"
}
}
]
}
Get a single user
GET https://api.engagedly.com/beta/users/<ID>
URL Parameters
| Parameter | Description |
|---|---|
| ID | The ID of the user |
URL Parameters for extra information
| Parameter | Description |
|---|---|
| include | primary_reporter,direct_reports,hr_managers,secondary_managers |
Sample Request
GET https://api.engagedly.com/api/beta/users/b62167d0-2718-4e45-9721-27535991becf
Sample Request with extra information
GET https://api.engagedly.com/api/beta/users/b62167d0-2718-4e45-9721-27535991becf?include=direct_reports
Sample Response
200 OK
content-type: application/json
{
"success": true,
"data": {
"id": "b62167d0-2718-4e45-9721-27535991becf",
"name": "Aron Jhon",
"first_name": "Aron",
"middle_name": null,
"last_name": "Jhon",
"employee_id": "s1212",
"status": "Active",
"email": "aron@teamyogi.com",
"display_picture": {
"medium": "http://social.engagedly.com//uploads/picture/file/751/reduced_Dan_Farmer1.jpg",
"small": "http://social.engagedly.com//uploads/picture/file/751/small_Dan_Farmer1.jpg"
},
"business_unit": [],
"employee_type": null,
"birthdate": "12-10-1983",
"departments": [],
"primary_reporter": null,
"direct_reports": [
{
"id": "1f6bec89-4d03-49d0-bf3d-ae0300830693",
"name": "satyam s s",
"first_name": "satyam",
"middle_name": "s",
"last_name": "s",
"employee_id": "980",
"status": "Active",
"email": "satyam@teamyogi.com",
"display_picture": null,
"job_title": null,
"business_unit": [],
"employee_type": null,
"location": null,
"birthdate": "12-10-1985",
"primary_reporter": null,
"education": null,
"about_me": null,
"phone_number": 2452323131,
"level": "3",
"secondary_phone_number": null,
"joining_date": "2014-05-23T10:39:48Z2",
"promotion_date": "2015-04-22T10:39:48Z2",
"review_date": nu"2015-04-22T10:39:48Z2"ll
}
],
"job_title": {
"id": "261",
"name": "CEO"
},
"location": {
"id": "11",
"name": "United States"
},
"education": "b.tech,MS",
"about_me": "Fun loving",
"phone_number": "3123433234",
"level": "2",
"secondary_phone_number": "2452323131",
"joining_date": "2013-04-22T10:39:48Z2",
"promotion_date": "2015-04-22T10:39:48Z",
"review_date": "2015-04-22T10:39:48Z"
}
}
Create a new user
POST https://api.engagedly.com/beta/users
Parameters
| ATTRIBUTE | TYPE | DESCRIPTION |
|---|---|---|
| first_name | string | First name of the user |
| middle_name | string | Middle name of the user |
| last_name | string | Last name of the user |
| string | Email Id of the user | |
| employee_id | string | Employee Id |
| joining_date | date | Date of which employee was hired |
| birth_date | date | Date of birth of the user |
| location | string | Id of the location |
| job_title | string | Id of the job title |
| employee_type | string | Type to which Emplyee belongs to |
| level | string | Level of the employee |
| phone_number | string | Phone number of the Epmloyee |
| secondary_phone_number | string | Secondary Phone number of the Epmloyee |
| promotion_date | string | Impending Promotion Date of the Employee |
| review_date | string | Impending Review Date of the Employee |
| departments | array of department ids | Array of departments for which this user would be part of |
| businesses | array of business ids | Array of businesses for which this user would be part of |
| hr_managers | array of ids | Array of HR Managers for the Employee |
| secondary_managers | array of ids | Array of Secondary Managers to whom the user may report to. |
| manager_id | string | Unique identifier of Manager to whom the user may report to. |
Sample Request
POST https://api.engagedly.com/beta/users
Sample Response
201 Created
content-type: application/json
{
"success": true,
"data": {
"id": "b62167d0-2718-4e45-9721-27535991becf",
"name": "Adam Smith",
"status": "Active",
"email": "adam.smith@teamyogi.com",
"first_name": "Adam",
"middle_name": null,
"last_name": "Smith",
"education": "BS- Anthropology, Stanford University",
"about_me": "I love exploring whether it is in business or ancient sites. Lets discover together.",
"employee_id": "E007",
"display_picture": {
"medium": "https://social.engagedly.com/uploads/picture/file/9634/reduced_Denzel.jpg",
"large": "https://social.engagedly.com/uploads/picture/file/9634/large_thumbnail_Denzel.jpg",
"small": "https://social.engagedly.com/uploads/picture/file/9634/small_Denzel.jpg"
},
"job_title": {
"id": "261",
"name": "CEO"
},
"joining_date": null,
"location": {
"id": "11",
"name": "United States"
},
"departments": [
{
"id": "1",
"name": "Customer Support",
"is_admin" : true
}
]
}
}
Update an existing user
PUT https://api.engagedly.com/beta/users/<ID>
URL Parameters
| Parameter | Description |
|---|---|
| ID | The ID of the user |
Parameters
| ATTRIBUTE | TYPE | DESCRIPTION |
|---|---|---|
| first_name | string | First name of the user |
| middle_name | string | Middle name of the user |
| last_name | string | Last name of the user |
| string | Email Id of the user | |
| employee_id | string | Employee Id |
| promotion_date | string | Impending Promotion Date of the Employee |
| review_date | string | Impending Review Date of the Employee |
| level | string | Level of the employee |
| phone_number | string | Phone number of the Epmloyee |
| secondary_phone_number | string | Secondary Phone number of the Epmloyee |
| joining_date | date | Date of which employee was hired |
| birth_date | date | Date of birth of the user |
| location | string | Id of the location |
| job_title | string | Id of the job title |
| departments | array of department ids | Array of departments for which this use would be part of |
| businesses | array of business ids | Array of businesses for which this user would be part of |
| hr_managers | array of ids | Array of HR Managers for the Employee |
| secondary_managers | array of ids | Array of Secondary Managers to whom the user may report to. | manager_id | string | Unique identifier of Manager to whom the user may report to. |
Sample Request
PUT https://api.engagedly.com/api/beta/users/b62167d0-2718-4e45-9721-27535991becf
Sample Response
200 OK
content-type: application/json
{
"success": true,
"data": {
"id": "b62167d0-2718-4e45-9721-27535991becf",
"name": "Adam Smith",
"status": "Active",
"email": "adam.smith@teamyogi.com",
"first_name": "Adam",
"middle_name": null,
"last_name": "Smith",
"employee_id": "E007",
"education": "BS- Anthropology, Stanford University",
"about_me": "I love exploring whether it is in business or ancient sites. Lets discover together.",
"display_picture": {
"medium": "https://social.engagedly.com/uploads/picture/file/9634/reduced_Denzel.jpg",
"large": "https://social.engagedly.com/uploads/picture/file/9634/large_thumbnail_Denzel.jpg",
"small": "https://social.engagedly.com/uploads/picture/file/9634/small_Denzel.jpg"
},
"job_title": {
"id": "261",
"name": "CEO"
},
"joining_date": null,
"location": {
"id": "11",
"name": "United States"
},
"departments": [
{
"id": "1",
"name": "Customer Support",
"is_admin" : true
}
]
}
}
Partially Update an existing user
PATCH https://api.engagedly.com/beta/users/<ID>
URL Parameters
| Parameter | Description |
|---|---|
| ID | The ID of the user |
Any Combination of Parameters can be sent in JSON body
| ATTRIBUTE | TYPE | DESCRIPTION |
|---|---|---|
| first_name | string | First name of the user |
| middle_name | string | Middle name of the user |
| last_name | string | Last name of the user |
| string | Email Id of the user | |
| employee_id | string | Employee Id |
| promotion_date | string | Impending Promotion Date of the Employee |
| review_date | string | Impending Review Date of the Employee |
| level | string | Level of the employee |
| phone_number | string | Phone number of the Epmloyee |
| secondary_phone_number | string | Secondary Phone number of the Epmloyee |
| joining_date | date | Date of which employee was hired |
| birth_date | date | Date of birth of the user |
| location | string | Id of the location |
| job_title | string | Id of the job title |
| departments | array of department ids | Array of departments for which this use would be part of |
| businesses | array of business ids | Array of businesses for which this user would be part of |
| hr_managers | array of ids | Array of HR Managers for the Employee |
| secondary_managers | array of ids | Array of Secondary Managers to whom the user may report to. | manager_id | string | Unique identifier of Manager to whom the user may report to. |
Sample Request
PATCH https://api.engagedly.com/api/beta/users/b62167d0-2718-4e45-9721-27535991becf
{
"last_name": "Smith",
"employee_id": "E007",
"education": "BS- Anthropology, Stanford University",
"departments": ["12312x1-1ex1-12eex-132e23ex-dw223e"]
}
Sample Response
200 OK
content-type: application/json
{
"success": true,
"data": {
"id": "b62167d0-2718-4e45-9721-27535991becf",
"name": "Adam Smith",
"status": "Active",
"email": "adam.smith@teamyogi.com",
"first_name": "Adam",
"middle_name": null,
"last_name": "Smith",
"employee_id": "E007",
"education": "BS- Anthropology, Stanford University",
"about_me": "I love exploring whether it is in business or ancient sites. Lets discover together.",
"display_picture": {
"medium": "https://social.engagedly.com/uploads/picture/file/9634/reduced_Denzel.jpg",
"large": "https://social.engagedly.com/uploads/picture/file/9634/large_thumbnail_Denzel.jpg",
"small": "https://social.engagedly.com/uploads/picture/file/9634/small_Denzel.jpg"
},
"job_title": {
"id": "261",
"name": "CEO"
},
"joining_date": null,
"location": {
"id": "11",
"name": "United States"
},
"departments": [
{
"id": "1",
"name": "Customer Support",
"is_admin" : true
}
]
}
}
Update user’s profile picture
PUT https://api.engagedly.com/beta/users/<ID>/profile/picture
URL Parameters
| Parameter | Description |
|---|---|
| ID | The ID of the user |
Parameters
| ATTRIBUTE | TYPE | DESCRIPTION |
|---|---|---|
| profile_picture | array | bytes of the picture |
Sample Request
PUT https://api.engagedly.com/api/beta/users/b62167d0-2718-4e45-9721-27535991becf/profile/picture
Sample Response
200 OK
content-type: application/json
{
"success": true
}
Get Block Reason Codes
GET https://api.engagedly.com/beta/users/block-reason-codes
Sample Request
GET https://api.engagedly.com/beta/users/block-reason-codes
Sample Response
200 OK
content-type: application/json
{
"success": true,
"data": [
{
"code": "involuntary",
"display_text": "Involuntary",
"description": "Initiated by the business. Example, RIF (Reduction in Force)"
},
{
"code": "dismissal_with_cause",
"display_text": "Dismissal with Cause",
"description": "Initiated by business. This field is for individuals that the business generally will not work with in the future and include this information in their employee record. Example, consistently poor performance, violation of company code of conduct"
},
{
"code": "fatigue",
"display_text": "Burnout",
"description": "Initiated by individual, but business can have a role in this as well."
},
{
"code": "sabatical",
"display_text": "Sabatical",
"description": "Initiated by business or individual. This field is for individuals that the organization may potentially want to work with again in the future. Example, personal leave of absence, contract expiration."
},
{
"code": "not_known",
"display_text": "Not Known",
"description": "The reason for deactivation is not known"
}
]
}
Deactivate an user
PUT https://api.engagedly.com/beta/users/<ID>/deactivate
URL Parameters
| Parameter | Description |
|---|---|
| ID | The ID of the user |
| block_reason_code | code for blocking reason (optional) |
Sample Request
PUT https://api.engagedly.com/api/beta/users/b62167d0-2718-4e45-9721-27535991becf/deactivate
{
"block_reason_code": "involuntary"
}
Sample Response
200 OK
content-type: application/json
{
"success": true,
"data": {
"id": "b62167d0-2718-4e45-9721-27535991becf",
"name": "Adam Smith",
"status": "Blocked",
"email": "adam.smith@teamyogi.com",
"first_name": "Adam",
"middle_name": null,
"last_name": "Smith",
"education": "BS- Anthropology, Stanford University",
"about_me": "I love exploring whether it is in business or ancient sites. Lets discover together.",
"display_picture": {
"medium": "https://social.engagedly.com/uploads/picture/file/9634/reduced_Denzel.jpg",
"large": "https://social.engagedly.com/uploads/picture/file/9634/large_thumbnail_Denzel.jpg",
"small": "https://social.engagedly.com/uploads/picture/file/9634/small_Denzel.jpg"
},
"job_title": {
"id": "261",
"name": "CEO"
},
"joining_date": null,
"location": {
"id": "11",
"name": "United States"
}
}
}
Activate an user
PUT https://api.engagedly.com/beta/users/<ID>/activate
URL Parameters
| Parameter | Description |
|---|---|
| ID | The ID of the user |
Sample Request
PUT https://api.engagedly.com/api/beta/users/b62167d0-2718-4e45-9721-27535991becf/activate
Sample Response
200 OK
content-type: application/json
{
"success": true,
"data": {
"id": "b62167d0-2718-4e45-9721-27535991becf",
"name": "Adam Smith",
"status": "Active",
"email": "adam.smith@teamyogi.com",
"first_name": "Adam",
"middle_name": null,
"last_name": "Smith",
"education": "BS- Anthropology, Stanford University",
"about_me": "I love exploring whether it is in business or ancient sites. Lets discover together.",
"display_picture": {
"medium": "https://social.engagedly.com/uploads/picture/file/9634/reduced_Denzel.jpg",
"large": "https://social.engagedly.com/uploads/picture/file/9634/large_thumbnail_Denzel.jpg",
"small": "https://social.engagedly.com/uploads/picture/file/9634/small_Denzel.jpg"
},
"job_title": {
"id": "261",
"name": "CEO"
},
"joining_date": null,
"location": {
"id": "11",
"name": "United States"
}
}
}
Permissions of an user
GET https://api.engagedly.com/beta/users/<ID>/permissions
URL Parameters
| Parameter | Description |
|---|---|
| ID | The ID of the user |
Sample Request
GET https://api.engagedly.com/api/beta/users/b62167d0-2718-4e45-9721-27535991becf/permissions
Sample Response
200 OK
content-type: application/json
{
"success": true,
"data": [
{
"id": 1,
"name": "Cycle - create / edit / delete performance review cycles",
"is_admin": null,
"description": ""
},
{
"id": 2,
"name": "Site Administrator",
"is_admin": true,
"description": "This role will be by default given to the admin. This role will contain all the permission. This role cannot be seperately given or remove to any other user. The user that has been marked as the org admin will by default get this role and will be removed from the role when the user is removed from the admin"
}
]
}
Update permissions of an user
PUT https://api.engagedly.com/beta/users/<ID>/permissions
URL Parameters
| Parameter | Description |
|---|---|
| ID | The ID of the user |
Parameters
| ATTRIBUTE | TYPE | DESCRIPTION |
|---|---|---|
| permission_ids | array | array of permissions ids |
Sample Request
PUT https://api.engagedly.com/api/beta/users/b62167d0-2718-4e45-9721-27535991becf/permissions
Sample Response
200 OK
content-type: application/json
{
"success": true,
"data": [
{
"id": 2070,
"name": "Cycle - create / edit / delete performance review cycles",
"is_admin": null,
"description": ""
},
{
"id": 45,
"name": "Site Administrator",
"is_admin": true,
"description": "This role will be by default given to the admin. This role will contain all the permission. This role cannot be seperately given or remove to any other user. The user that has been marked as the org admin will by default get this role and will be removed from the role when the user is removed from the admin"
}
]
}
Departments
List all departments
GET https://api.engagedly.com/beta/departments
Sample Request
GET https://api.engagedly.com/beta/departments
Sample Response
200 OK
content-type: application/json
{
"success": true,
"pagination": {
"page": 1,
"size": 30,
"has_more": false,
"total_records": 5
},
"data": [
{
"id": "f5afec62-21ff-40d3-a06e-9a2162ef6b69",
"name": "Customer Support",
"members_count": "10",
"administrators_count": "2"
}
]
}
Get a single department
GET https://api.engagedly.com/beta/departments/<ID>
URL Parameters
| Parameter | Description |
|---|---|
| ID | The ID of the department |
Sample Request
GET https://api.engagedly.com/api/beta/departments/f5afec62-21ff-40d3-a06e-9a2162ef6b69
Sample Response
200 OK
content-type: application/json
{
"success": true,
"data": {
"id": "f5afec62-21ff-40d3-a06e-9a2162ef6b69",
"name": "Customer Support",
"members_count": "10",
"administrators_count": "2",
"members": [
{
"id": "b62167d0-2718-4e45-9721-27535991becf",
"name": "Adam Smith",
"email": "adam.smith@teamyogi.com",
"first_name": "Adam",
"middle_name": null,
"last_name": "Smith",
"display_picture": {
"medium": "https://social.engagedly.com/uploads/picture/file/9634/reduced_Denzel.jpg",
"small": "https://social.engagedly.com/uploads/picture/file/9634/small_Denzel.jpg"
},
"is_admin": true
},
]
}
}
Create a new department
POST https://api.engagedly.com/beta/departments
Parameters
| ATTRIBUTE | TYPE | DESCRIPTION |
|---|---|---|
| name | string | Name of the department |
| members | array | Array of user ids |
Sample Request
POST https://api.engagedly.com/api/beta/departments
Sample Response
201 Created
content-type: application/json
{
"success": true,
"data": {
"id": "f5afec62-21ff-40d3-a06e-9a2162ef6b69",
"name": "Customer Support",
"members_count": "10",
"administrators_count": "2",
"members": [
{
"id": "b62167d0-2718-4e45-9721-27535991becf",
"name": "Adam Smith",
"email": "adam.smith@teamyogi.com",
"first_name": "Adam",
"middle_name": null,
"last_name": "Smith",
"display_picture": {
"medium": "https://social.engagedly.com/uploads/picture/file/9634/reduced_Denzel.jpg",
"small": "https://social.engagedly.com/uploads/picture/file/9634/small_Denzel.jpg"
},
"is_admin": true
},
]
}
}
Update an existing department
PUT https://api.engagedly.com/beta/departments/<ID>
URL Parameters
| Parameter | Description |
|---|---|
| ID | The ID of the department |
Parameters
| ATTRIBUTE | TYPE | DESCRIPTION |
|---|---|---|
| name | string | Name of the department |
| members | array | Array of user ids |
Sample Request
PUT https://api.engagedly.com/beta/departments/f5afec62-21ff-40d3-a06e-9a2162ef6b69
Sample Response
200 OK
content-type: application/json
{
"success": true,
"data": {
"id": "1",
"name": "Customer Support",
"members": [
{
"id": "b62167d0-2718-4e45-9721-27535991becf",
"name": "Adam Smith",
"email": "adam.smith@teamyogi.com",
"first_name": "Adam",
"middle_name": null,
"last_name": "Smith",
"display_picture": {
"medium": "https://social.engagedly.com/uploads/picture/file/9634/reduced_Denzel.jpg",
"small": "https://social.engagedly.com/uploads/picture/file/9634/small_Denzel.jpg"
},
"is_admin": true
},
]
}
}
Delete a department
DELETE https://api.engagedly.com/beta/departments/<ID>
URL Parameters
| Parameter | Description |
|---|---|
| ID | The ID of the department |
Sample Request
DELETE https://api.engagedly.com/beta/departments/f5afec62-21ff-40d3-a06e-9a2162ef6b69
Sample Response
204 No Content
Businesses
List all businesses
GET https://api.engagedly.com/beta/businesses
Sample Request
GET https://api.engagedly.com/beta/businesses
Sample Response
200 OK
content-type: application/json
{
"success": true,
"pagination": {
"page": 1,
"size": 30,
"has_more": false,
"total_records": 2
},
"data": [
{
"id": "f5afec62-21ff-40d3-a06e-9a2162ef6b69",
"name": "Manufacturing Unit",
"members_count": "10",
"administrators_count": "2"
},
{
"id": "23eceer-21ff-23cd-a06e-9a2162ef6b69",
"name": "EMCA-Unit",
"members_count": "5",
"administrators_count": "1"
}
]
}
Get a single business
GET https://api.engagedly.com/beta/businesses/<ID>
URL Parameters
| Parameter | Description |
|---|---|
| ID | The ID of the business |
Sample Request
GET https://api.engagedly.com/api/beta/businesses/23eceer-21ff-23cd-a06e-9a2162ef6b69
Sample Response
200 OK
content-type: application/json
{
"success": true,
"data": {
"id": "23eceer-21ff-23cd-a06e-9a2162ef6b69",
"name": "EMCA-Unit",
"members_count": 1,
"administrators_count": 1,
"members": [
{
"id": "a178a039-4e79-4e3e-87f0-c88440a6d8c6",
"name": "ROBERT J Jacob",
"email": "robert.jacob@engagedly.com",
"first_name": "ROBERT",
"middle_name": "J",
"last_name": "Jacob",
"display_picture": {
"medium": "https://social.engagedly.com/uploads/picture/file/9634/reduced_Denzel.jpg",
"small": "https://social.engagedly.com/uploads/picture/file/9634/small_Denzel.jpg"
},
"is_admin": false
}
]
}
}
Create a new business
POST https://api.engagedly.com/beta/businesses
Parameters
| ATTRIBUTE | TYPE | DESCRIPTION |
|---|---|---|
| name | string | Name of the business |
| members | array | Array of user ids |
Sample Request
POST https://api.engagedly.com/api/beta/businesses
Sample Response
201 Created
content-type: application/json
{
"success": true,
"data": {
"id": "23eceer-21ff-23cd-a06e-9a2162ef6b69",
"name": "EMCA-Unit",
"members_count": 1,
"administrators_count": 1,
"members": [
{
"id": "a178a039-4e79-4e3e-87f0-c88440a6d8c6",
"name": "ROBERT J Jacob",
"email": "robert.jacob@engagedly.com",
"first_name": "ROBERT",
"middle_name": "J",
"last_name": "Jacob",
"display_picture": {
"medium": "https://social.engagedly.com/uploads/picture/file/9634/reduced_Denzel.jpg",
"small": "https://social.engagedly.com/uploads/picture/file/9634/small_Denzel.jpg"
},
"is_admin": false
}
]
}
}
Update an existing business
PUT https://api.engagedly.com/beta/businesses/<ID>
URL Parameters
| Parameter | Description |
|---|---|
| ID | The ID of the business |
Parameters
| ATTRIBUTE | TYPE | DESCRIPTION |
|---|---|---|
| name | string | Name of the business |
| members | array | Array of user ids |
Sample Request
PUT https://api.engagedly.com/beta/businesses/23eceer-21ff-23cd-a06e-9a2162ef6b69
Sample Response
200 OK
content-type: application/json
{
"success": true,
"data": {
"id": "23eceer-21ff-23cd-a06e-9a2162ef6b69",
"name": "EMCA-Unit-Updated",
"members_count": 1,
"administrators_count": 1,
"members": [
{
"id": "a178a039-4e79-4e3e-87f0-c88440a6d8c6",
"name": "ROBERT J Jacob",
"email": "robert.jacob@engagedly.com",
"first_name": "ROBERT",
"middle_name": "J",
"last_name": "Jacob",
"display_picture": {
"medium": "https://social.engagedly.com/uploads/picture/file/9634/reduced_Denzel.jpg",
"small": "https://social.engagedly.com/uploads/picture/file/9634/small_Denzel.jpg"
},
"is_admin": false
}
]
}
}
Delete a business
DELETE https://api.engagedly.com/beta/businesses/<ID>
URL Parameters
| Parameter | Description |
|---|---|
| ID | The ID of the business |
Sample Request
DELETE https://api.engagedly.com/beta/businesses/23eceer-21ff-23cd-a06e-9a2162ef6b69
Sample Response
204 No Content
Locations
List all locations
GET https://api.engagedly.com/beta/locations
Sample Request
GET https://api.engagedly.com/beta/locations
Sample Response
200 OK
content-type: application/json
{
"success": true,
"pagination": {
"page": 1,
"size": 30,
"has_more": false,
"total_records": 1
},
"data": [
{
"id": "1",
"name": "Head Office",
"address_line1": "",
"address_line2" : "",
"city": "",
"state": "",
"country" : "",
"postal_code" : ""
}
]
}
Get a single location
GET https://api.engagedly.com/beta/locations/<ID>
URL Parameters
| Parameter | Description |
|---|---|
| ID | The ID of the location |
Sample Request
GET https://api.engagedly.com/api/beta/locations/1
Sample Response
200 OK
content-type: application/json
{
"success": true,
"data": {
"id": "1",
"name": "Head Office",
"address_line1": "",
"address_line2" : "",
"city": "",
"state": "",
"country" : "",
"postal_code" : ""
}
}
Create a new location
POST https://api.engagedly.com/beta/locations
Parameters
| ATTRIBUTE | TYPE | DESCRIPTION |
|---|---|---|
| name | string | Name of the location |
| address_line1 | string | Line 1 of the address |
| address_line2 | string | Line 2 of the address |
| city | string | City of the location |
| state | string | State of the location |
| country | string | Country of the location |
| postal_code | string | Postal code of the location |
Sample Request
POST https://api.engagedly.com/api/beta/locations
Sample Response
201 Created
content-type: application/json
{
"success": true,
"data": {
"id": "1",
"name": "Head Office",
"address_line1": "",
"address_line2" : "",
"city": "",
"state": "",
"country" : "",
"postal_code" : ""
}
}
Update an existing location
PUT https://api.engagedly.com/beta/locations/<ID>
URL Parameters
| Parameter | Description |
|---|---|
| ID | The ID of the location |
Parameters
| ATTRIBUTE | TYPE | DESCRIPTION |
|---|---|---|
| name | string | Name of the location |
| address_line1 | string | Line 1 of the address |
| address_line2 | string | Line 2 of the address |
| city | string | City of the location |
| state | string | State of the location |
| country | string | Country of the location |
| postal_code | string | Postal code of the location |
Sample Request
PUT https://api.engagedly.com/api/beta/locations/1
Sample Response
200 OK
content-type: application/json
{
"success": true,
"data": {
"id": "1",
"name": "Head Office",
"address_line1": "",
"address_line2" : "",
"city": "",
"state": "",
"country" : "",
"postal_code" : ""
}
}
Delete a location
DELETE https://api.engagedly.com/beta/locations/<ID>
URL Parameters
| Parameter | Description |
|---|---|
| ID | The ID of the location |
Sample Request
DELETE https://api.engagedly.com/api/beta/locations/1
Sample Response
204 No Content
Job Titles
List all job titles
GET https://api.engagedly.com/beta/job_titles
Sample Request
GET https://api.engagedly.com/beta/job_titles
Sample Response
200 OK
content-type: application/json
{
"success": true,
"pagination": {
"page": 1,
"size": 30,
"has_more": false,
"total_records": 1
},
"data": [
{
"id": "1",
"name": "Head Office",
"description": "",
"responsibilities": ""
}
]
}
Get a single job title
GET https://api.engagedly.com/beta/job_titles/<ID>
URL Parameters
| Parameter | Description |
|---|---|
| ID | The ID of the job title |
Sample Request
GET https://api.engagedly.com/api/beta/job_titles/1
Sample Response
200 OK
content-type: application/json
{
"success": true,
"data": {
"id": "1",
"name": "Head Office",
"description": "",
"responsibilities": ""
}
}
Create a new job title
POST https://api.engagedly.com/beta/job_titles
Parameters
| ATTRIBUTE | TYPE | DESCRIPTION |
|---|---|---|
| name | string | Name of the job title |
| description | string | Description of the job title |
| responsibilities | string | Responsibilities of the job titles |
Sample Request
POST https://api.engagedly.com/api/beta/job_titles
Sample Response
201 Created
content-type: application/json
{
"success": true,
"data": {
"id": "1",
"name": "Head Office",
"description": "",
"responsibilities": ""
}
}
Update an existing job title
PUT https://api.engagedly.com/beta/job_titles/<ID>
URL Parameters
| Parameter | Description |
|---|---|
| ID | The ID of the job title |
Parameters
| ATTRIBUTE | TYPE | DESCRIPTION |
|---|---|---|
| name | string | Name of the job title |
| description | string | Description of the job title |
| responsibilities | string | Responsibilities of the job titles |
Sample Request
PUT https://api.engagedly.com/api/beta/job_titles/1
Sample Response
200 OK
content-type: application/json
{
"success": true,
"data": {
"id": "1",
"name": "Head Office",
"description": "",
"responsibilities": ""
}
}
Delete a job title
DELETE https://api.engagedly.com/beta/job_titles/<ID>
URL Parameters
| Parameter | Description |
|---|---|
| ID | The ID of the job title |
Sample Request
DELETE https://api.engagedly.com/api/beta/job_titles/1
Sample Response
204 No Content
Permissions
List all permissions
GET https://api.engagedly.com/beta/permissions
Sample Request
GET https://api.engagedly.com/beta/permissions
Sample Response
200 OK
content-type: application/json
{
"success": true,
"pagination": {
"page": 1,
"size": 25,
"has_more": false,
"total_records": 1
},
"data": [
{
"id": 1,
"name": "Site Administrator",
"is_admin": true,
"description": "This role will be by default given to the admin. This role will contain all the permission. This role cannot be seperately given or remove to any other user. The user that has been marked as the org admin will by default get this role and will be removed from the role when the user is removed from the admin"
}
]
}
Activities
Get all public Praises
GET https://api.engagedly.com/beta/activities/praises
Sample Request
GET https://api.engagedly.com/beta/activities/praises
Sample Response
200 OK
content-type: application/json
{
"success": true,
"pagination": {
"page": 2,
"size": 50,
"has_more": false,
"total_records": 1
},
"data": [
{
"id": 107781,
"activity_type": "Praise",
"activity_date": "2019-01-30T06:56:24.895Z",
"last_updated_at": "2019-01-30T06:56:24.895Z",
"title": null,
"content": "goodd work...",
"pinned": false,
"author": {
"name": "Aaron Kutcher",
"id": "9fcb1375-e11a-4492-b7e8-39d3912231dd",
"display_picture": {
"large": "http://social.engagedly.local:3005/uploads/picture/file/3073/reduced_images__2_.jpg",
"original": "http://social.engagedly.local:3005/uploads/picture/file/3073/images__2_.jpg",
"reduced": "http://social.engagedly.local:3005/uploads/picture/file/3073/reduced_images__2_.jpg"
},
"designation": "Promoter"
},
"tags": [
{
"code": "goodwork",
"label": "goodwork"
}
],
"audience": [
{
"name": "Everyone",
"id": "6e9c487c-c23a-44ec-9fe6-a4a4e527552c",
"display_picture": {
"large": null,
"original": null,
"reduced": null
},
"type": "Group"
}
],
"links": [],
"attachments": [],
"comment_details": {
"count": 0
},
"like_details": {
"count": 0,
"is_liked": false
},
"can_edit": true,
"can_delete": true,
"recognized_actors": [
{
"name": "Looks L Das",
"id": "e5838577-2612-44f8-a684-167fdcf2e524",
"display_picture": {
"large": null,
"original": null,
"reduced": null
},
"designation": "Accountant"
}
]
},
{
"id": 107780,
"activity_type": "Praise",
"activity_date": "2019-01-30T06:54:25.287Z",
"last_updated_at": "2019-01-30T06:54:25.287Z",
"title": null,
"content": "good work...",
"pinned": false,
"author": {
"name": "Aaronn Astons",
"id": "9fcb1375-e11a-4492-b7e8-39d3912231dd",
"display_picture": {
"large": "http://social.engagedly.local:3005/uploads/picture/file/3073/reduced_images__2_.jpg",
"original": "http://social.engagedly.local:3005/uploads/picture/file/3073/images__2_.jpg",
"reduced": "http://social.engagedly.local:3005/uploads/picture/file/3073/reduced_images__2_.jpg"
},
"designation": "Promoter"
},
"audience": [
{
"name": "Everyone",
"id": "6e9c487c-c23a-44ec-9fe6-a4a4e527552c",
"display_picture": {
"large": null,
"original": null,
"reduced": null
},
"type": "Group"
}
],
"links": [],
"attachments": [],
"comment_details": {
"count": 0
},
"like_details": {
"count": 0,
"is_liked": false
},
"can_edit": true,
"can_delete": true,
"recognized_actors": [
{
"name": "Looks L Das",
"id": "e5838577-2612-44f8-a684-167fdcf2e524",
"display_picture": {
"large": null,
"original": null,
"reduced": null
},
"designation": "Accountant"
}
]
}
]
}