✅Tasks

Create/Update/Get/Delete tasks within your tenant and account.

After creating a task, you can also assign subtasks inside of it via the Subtasks API.

Create task

POST https://app.ninjapipe.com/api/v1/tasks/create

Creates a new task in your tenant.

Make sure to add API_KEY as a header. This is your API Key found in the API & Integrations page.

Create Task

post
Authorizations
Header parameters
API_KEYstringOptionalExample: API_KEY
Body
objectOptionalExample: {"taskName":"Website Redesign","description":"Redesign the company homepage to improve user experience.","startDate":"2023-06-15T09:00:00","endDate":"2023-07-15T17:00:00","local_date":"2023-06-15T09:00:00","isCompleted":false}
Responses
200

Successful response

application/json
post
POST /api/v1/tasks/create HTTP/1.1
Host: app.ninjapipe.com
Authorization: noauth YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 226

{
  "taskName": "Website Redesign",
  "description": "Redesign the company homepage to improve user experience.",
  "startDate": "2023-06-15T09:00:00",
  "endDate": "2023-07-15T17:00:00",
  "local_date": "2023-06-15T09:00:00",
  "isCompleted": false
}
200

Successful response

No content

Update a task

PUThttps://app.ninjapipe.com/api/v1/tasks/{task_id}/update

Update Task

put
Authorizations
Header parameters
API_KEYstringOptionalExample: API_KEY
Body
objectOptionalExample: {"taskName":"Website Redesign!","description":"Redesign the company homepage to improve user experience.","startDate":"2023-06-15T09:00:00","endDate":"2023-07-15T17:00:00","local_date":"2023-06-15T09:00:00","isCompleted":false}
Responses
200

Successful response

application/json
put
PUT /api/v1/tasks/749/update HTTP/1.1
Host: app.ninjapipe.com
Authorization: noauth YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 227

{
  "taskName": "Website Redesign!",
  "description": "Redesign the company homepage to improve user experience.",
  "startDate": "2023-06-15T09:00:00",
  "endDate": "2023-07-15T17:00:00",
  "local_date": "2023-06-15T09:00:00",
  "isCompleted": false
}
200

Successful response

No content

Get task

GEThttps://app.ninjapipe.com/api/v1/tasks/getTaskById?id={task_id}

Get Task

get
Authorizations
Query parameters
idintegerOptionalExample: 749
Header parameters
API_KEYstringOptionalExample: API_KEY
Responses
200

Successful response

application/json
get
GET /api/v1/tasks/getTaskById HTTP/1.1
Host: app.ninjapipe.com
Authorization: noauth YOUR_SECRET_TOKEN
Accept: */*
200

Successful response

No content

Get all tasks

GEThttps://app.ninjapipe.com/api/v1/tasks/getall

Parameters:

  • getall?page=1 - Use this to paginate

Get Tasks

get
Authorizations
Query parameters
pageintegerOptionalExample: 1
Header parameters
API_KEYstringOptionalExample: API_KEY
Responses
200

Successful response

application/json
get
GET /api/v1/tasks/getall HTTP/1.1
Host: app.ninjapipe.com
Authorization: noauth YOUR_SECRET_TOKEN
Accept: */*
200

Successful response

No content

Mark task as complete

GEThttps://app.ninjapipe.com/api/v1/tasks/{task_id}/saveCheckStatus

Mark Task Complete

put
Authorizations
Header parameters
API_KEYstringOptionalExample: API_KEY
Body
objectOptionalExample: {"isCompleted":true}
Responses
200

Successful response

application/json
put
PUT /api/v1/tasks/749/saveCheckStatus HTTP/1.1
Host: app.ninjapipe.com
Authorization: noauth YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "isCompleted": true
}
200

Successful response

No content
PreviousContactsNextSubtasks

Last updated