API docs by Apploye

Apploye Public API References (1.0.0)

Download OpenAPI specification:Download

A public API, or application programming interface, is a set of protocols, routines, and tools for building software and applications. It specifies how software components should interact and APIs allow for communication between different systems. Public APIs are available to developers and other users with minimal restrictions, allowing them to access the functionality of a program or service. This can include things like retrieving data or posting new information. Public APIs are often used to integrate different systems and services.

We are providing REST-based API. Users can get data from Apploye about the Organization, Projects and Timesheets. Project data contains list of project's tasks, project's assignees and list of all projects of the organization.

Authentication

To get the data from Apploye, all the requests must inclue X-APPLOYE-API-KEY in api request header. The value of the key will be Organization API Key. You will find it here API KEY. But the user need to be either Organization Admin or Owner to get the API Key.

URL

https://public-api.apploye.com

Member

Member Endpoint

Get organization members list

Authorizations:
apiKeyAuth
query Parameters
user_id
string
email
string <email>
user_name
string

Responses

Request samples 

curl -i -X GET \
  'https://public-api.apploye.com/members/?user_id=string&email=user%40example.com&name=string' \
  -H 'X-APPLOYE-API-KEY: YOUR_API_KEY_HERE'

Response samples

Content type
application/json
{
  • "success": true,
  • "page": 3,
  • "per_page": 20,
  • "total": 100,
  • "response": [
    ]
}

Timesheet

Timesheet Endpoint

Get organization timesheets list

Authorizations:
apiKeyAuth
query Parameters
start_date
required
string <date-time>

Give the start date & time of timesheet

end_date
required
string <date-time>

Give the end date & time of the timesheet

Responses

Request samples 

curl -i -X GET \
  'https://public-api.apploye.com/timesheets/?start_date=2019-08-24T14%3A15%3A22Z&end_date=2019-08-24T14%3A15%3A22Z' \
  -H 'X-APPLOYE-API-KEY: YOUR_API_KEY_HERE'

Response samples

Content type
application/json
{
  • "success": true,
  • "page": 3,
  • "per_page": 20,
  • "total": 100,
  • "response": [
    ]
}

Project

Project Endpoints

Get organization projects list

Authorizations:
apiKeyAuth
query Parameters
project_id
string

Filter Using Project Id

project_name
string

Filter Using Project Name

status
string

Filter Using Project Status

page_no
string

Enter the page no

Responses

Request samples 

curl -i -X GET \
  'https://public-api.apploye.com/project/?project_id=string&project_name=string&status=string&page_no=string' \
  -H 'X-APPLOYE-API-KEY: YOUR_API_KEY_HERE'

Response samples

Content type
application/json
{
  • "success": true,
  • "page": 3,
  • "per_page": 20,
  • "total": 100,
  • "response": [
    ]
}

Get project assignees list

Authorizations:
apiKeyAuth
path Parameters
projectId
required
string <uuid>

Id of the Project

query Parameters
user_id
string <uuid>

Filter By User Id

email
string <email>

Filter By User Email

name
string

Filter By User Name

Responses

Request samples 

curl -i -X GET \
  'https://public-api.apploye.com/project/{projectId}/assignees/?user_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&email=user%40example.com&name=string' \
  -H 'X-APPLOYE-API-KEY: YOUR_API_KEY_HERE'

Response samples

Content type
application/json
{
  • "success": true,
  • "page": 3,
  • "per_page": 20,
  • "total": 100,
  • "response": [
    ]
}

Get project tasks list

Authorizations:
apiKeyAuth
path Parameters
projectId
required
string <uuid>

Project Id

query Parameters
task_status
string

Filter task by status

task_name
string

Filter tasks by task name

Responses

Request samples 

curl -i -X GET \
  'https://public-api.apploye.com/project/{projectId}/tasks/?task_status=string&task_name=string' \
  -H 'X-APPLOYE-API-KEY: YOUR_API_KEY_HERE'

Response samples

Content type
application/json
{
  • "success": true,
  • "page": 3,
  • "per_page": 20,
  • "total": 100,
  • "response": [
    ]
}