Introduction

The Plutio API is a RESTful interface, resource-oriented URLs and uses HTTP response codes to indicate API errors, allowing you to programmatically update and access much of your data on the platform. It provides predictable URLs for accessing resources, and uses built-in HTTP features to receive commands and return responses. This makes it easy to communicate with from a wide variety of environments, from command-line utilities to browser plugins to native applications. *JSON is returned by all API responses, including errors.

Changelog

1 October, 2024

Introduction of new endpoints to support our latest feature updates:

  • Bulk select and edit
  • Archiving
  • Schedulers
  • Transactions

Also in this update, we introduced a way to get invitation URL and remove all items from trash via our API.

Authentication

We use a standard OAuth 2 authentication method.

You can generate an application key and a secret code from your settings page inside the Plutio app and use them to create a temporary access token.

YOUR_PLUTIO_SUBDOMAIN header value should be the first part of your Plutio domain. For example YOUR_PLUTIO_SUBDOMAIN value for https://test.plutio.com would be test.

Visit the "Getting Started" section for more information.

Error Codes

Code

Description

400

Bad request. The server cannot or will not process the request due to an apparent client error (malformed request syntax, invalid params)

401

Unauthorized. Access token is invalid or missing.

403

Forbidden. User is not allowed to perform the action, usually due to permission settings.

404

Not found. The requested resource could not be found.

405

Method not allowed. A request method is not supported for the requested resource; for example, a GET request on a form that requires data to be presented via POST

429

Too Many Requests. Your API limits have been reached.

500

Internal server error. Server could not process your request due to unexpected condition. Please try again later or if the issue persists please contact us.

Rate limit

There is a current limit of 1000 API calls an hour.

Paging

You can use skip and limit query parameters to get a different set of items.https://api.plutio.com/v1.8/tasks?skip=20&limit=50This will return tasks 21..70

Advanced queries (BETA)

You can use basic filters by supplying key-value pairs in GET request. For example to get a contact(s) with the first name of "leo", the get request URL would be https://api.plutio.com/v1.8/people?name.first=leo

In cases where advanced filters are required, a special query param q can be used to provide a raw MongoDB query. This allows you to build queries such as finding contact(s) who have the first name as "Leo" or the last name as "Doe". For example https://api.plutio.com/v1.8/people?q={"$or":[{"name.first": "John" }, { "name.last": "Doe" }]} (Value must be a valid JSON)

Getting started

POST Generate access token

Archives

GET Get archive

DELETE Delete archive

DELETE Delete bulk archive

Block Groups

PUT Update block group

GET Get block group

Blocks

POST Create block

PUT Update block

GET Get block

DELETE Delete block

Businesses

PUT Update business

GET Get business

Canned Responses

POST Create canned response

PUT Update canned response

GET Get canned response

DELETE Delete canned response

Categories

POST Create category

PUT Update category

GET Get category

DELETE Delete category

Comments

POST Create comment

PUT Update comment

GET Get comment

DELETE Delete comment

Companies

POST Create company

PUT Update company

PUT Update bulk company

GET Get company

DELETE Delete company

DELETE Delete bulk company

Contracts

POST Create contract

POST Archive contract

POST Archive bulk contract

PUT Update contract

PUT Update bulk contract

GET Get contract

DELETE Delete contract

DELETE Delete bulk contract

Conversations

POST Create conversation

PUT Update conversation

GET Get conversation

DELETE Delete conversation

Custom Fields

POST Create custom field

PUT Update custom field

GET Get custom field

DELETE Delete custom field

Dashboard Data

GET Get dashboard data

Dashboard Pages

POST Create dashboard page

PUT Update dashboard page

GET Get dashboard page

DELETE Delete dashboard page

Dashboards

PUT Update dashboard

GET Get dashboard

Events

POST Create event

PUT Update event

GET Get event

DELETE Delete event

File Folders

POST Create file folder

POST Move file folder

PUT Update file folder

GET Get file folder

DELETE Delete file folder

Files

POST Create file

POST Move file

PUT Update file

PUT Update bulk file

GET Get file

DELETE Delete file

DELETE Delete bulk file

Form Responses

POST Create form response

PUT Update form response

GET Get form response

DELETE Delete form response

DELETE Delete bulk form response

Forms

POST Create form

POST Copy form

POST Archive form

POST Archive bulk form

PUT Update form

PUT Update bulk form

GET Get form

DELETE Delete form

DELETE Delete bulk form

Inbox Groups

POST Create inbox group

PUT Update inbox group

GET Get inbox group

DELETE Delete inbox group

Invoice Subscriptions

POST Create invoice subscription

PUT Update invoice subscription

PUT Update bulk invoice subscription

GET Get invoice subscription

DELETE Delete invoice subscription

DELETE Delete bulk invoice subscription

Invoices

POST Create invoice

POST Archive invoice

POST Archive bulk invoice

PUT Update invoice

PUT Update bulk invoice

GET Get invoice

DELETE Delete invoice

DELETE Delete bulk invoice

Items

POST Create item

PUT Update item

GET Get item

DELETE Delete item

Notes

POST Create note

PUT Update note

GET Get note

DELETE Delete note

People

POST Create person

POST Archive person

POST Archive bulk person

PUT Update person

PUT Update bulk person

GET Get person

GET Get invitation code of person

DELETE Delete person

DELETE Delete bulk person

Profiles

GET Get profile

Projects

POST Create project

POST Move project

POST Copy project

POST Archive project

POST Archive bulk project

PUT Update project

PUT Update bulk project

GET Get project

DELETE Delete project

DELETE Delete bulk project

Proposals

POST Create proposal

POST Archive proposal

POST Archive bulk proposal

PUT Update proposal

PUT Update bulk proposal

GET Get proposal

DELETE Delete proposal

DELETE Delete bulk proposal

Roles

POST Create role

PUT Update role

DELETE Delete role

Schedulers

POST Create scheduler

POST Copy scheduler

POST Archive scheduler

POST Archive bulk scheduler

PUT Update scheduler

PUT Update bulk scheduler

GET Get scheduler

DELETE Delete scheduler

DELETE Delete bulk scheduler

Statuses

POST Create status

POST Move status

PUT Update status

GET Get status

DELETE Delete status

Task Boards

POST Create task board

POST Move task board

POST Copy task board

POST Archive task board

PUT Update task board

GET Get task board

DELETE Delete task board

Task Groups

POST Create task group

POST Move task group

POST Copy task group

POST Archive task group

PUT Update task group

GET Get task group

DELETE Delete task group

Tasks

POST Create task

POST Move task

POST Copy task

POST Archive task

POST Archive bulk task

PUT Update task

PUT Update bulk task

GET Get task

DELETE Delete task

DELETE Delete bulk task

Templates

POST Create template

PUT Update template

GET Get template

DELETE Delete template

Time Tracks

POST Create time track

PUT Update time track

PUT Update bulk time track

GET Get time track

DELETE Delete time track

DELETE Delete bulk time track

Transactions

POST Create transaction

POST Copy transaction

POST Archive transaction

POST Archive bulk transaction

PUT Update transaction

PUT Update bulk transaction

GET Get transaction

DELETE Delete transaction

DELETE Delete bulk transaction

Trash bin

GET Get trash bin

DELETE Delete trash bin

DELETE Delete all trash bin

DELETE Delete bulk trash bin

Wiki

POST Create wiki

PUT Update wiki

GET Get wiki

DELETE Delete wiki

Wiki Entities

POST Create wiki entity

POST Move wiki entity

PUT Update wiki entity

GET Get wiki entity

DELETE Delete wiki entity