Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Erply task API

The task API from Erply — 4 operation(s) for task.

Erply task API is one of 64 APIs that Erply publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include task. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 4 paths, and defines 4 schemas. It is described by OpenAPI 2.0, at version 2.36.5.

Requests are made against the base URL https://api-pim-eu.erply.com.

6 operations 4 paths 4 schemas 2 DELETE1 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
2.36.5
Base URL
https://api-pim-eu.erply.com
Authentication
API Key, API Key, API Key, API Key, API Key
Resource Areas
1

Authentication & Security 5

Erply task API declares 5 security schemes for authenticating requests. An API key is passed in the header as accessToken (AccessToken). An API key is passed in the header as clientCode (ErplyClientCode). An API key is passed in the header as jwt (ErplyJWT). An API key is passed in the header as sessionKey (ErplySession). An API key is passed in the header as requestKey (RequestKey).

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 2 DELETE, 1 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

task 6
GET
/api/v1/task
Look up any tasks
24 params → 200401500
POST
/api/v1/task
Add a new task record
1 param → 201400401500
POST
/api/v1/task/reschedule
Reschedule tasks if so configured
→ 202401500
DELETE
/api/v1/task/{taskId}
Delete one task record
1 param → 200400401404500
PATCH
/api/v1/task/{taskId}
Update task record
2 params → 200400401404500
DELETE
/api/v1/task/{taskId}/{repeatId}
Delete one task within a recurring task chain
2 params → 200400401404500

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are TaskResponse (24 properties), TaskRequest (14 properties), NoteResponse (12 properties), LabelResponse (6 properties). Each schema is shown below with its type and property counts.

TaskRequest
object
14 properties
LabelResponse
object
6 properties
TaskResponse
object
24 properties
NoteResponse
object
12 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

erply-task-api-openapi.yml Raw ↑

Other APIs Erply publishes across the network.

Erply Assortment API
Erply Assortment To Product Linking API
Erply Attributes API
Erply auth API
Erply Brand API
Erply clsf API
Erply clsf-device-properties API
Erply clsf-events API
Erply clsf-labels API
Erply Country API
Erply device API
Erply event API