How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Opply Tasks API

The Tasks API from Opply — 17 operation(s) for tasks.

Opply Tasks API is one of 47 APIs that Opply 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 26 operations across 17 paths, and defines 38 schemas. It is described by OpenAPI 3.0.3, at version 0.0.0.

Requests are made against the base URL https://api.opply.com.

26 operations 17 paths 38 schemas 4 DELETE8 GET2 PATCH11 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
0.0.0
Base URL
https://api.opply.com
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Opply Tasks API declares 2 security schemes for authenticating requests. An API key is passed in the cookie as sessionid (cookieAuth). An API key is passed in the header as Authorization (tokenAuth).

  • tokenAuth — Token-based authentication with required prefix "Token"

Paths & Operations 26

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

Tasks 26
GET
/api/v1/chat/
List a task's chat messages
api_v1_chat_list 3 params → 200
POST
/api/v1/chat/
Post a chat message
api_v1_chat_create body → 201
POST
/api/v1/chat/{uuid}/react/
Add or remove an emoji reaction on a chat message
api_v1_chat_react_create 2 params → 200
DELETE
/api/v1/chat/{uuid}/react/
Add or remove an emoji reaction on a chat message
api_v1_chat_react_destroy 2 params → 200
POST
/api/v1/chat/mark-read/
Mark a task's chat read
api_v1_chat_mark_read_create 2 params → 200
GET
/api/v1/task-recurrences/{uuid}/
Get a recurring-task series
api_v1_task_recurrences_retrieve 1 param → 200
PATCH
/api/v1/task-recurrences/{uuid}/
Partially update a recurring-task series
api_v1_task_recurrences_partial_update 1 param body → 200
POST
/api/v1/task-recurrences/{uuid}/disable/
Pause a recurring-task series (Turn off repeat)
api_v1_task_recurrences_disable_create 1 param → 200
POST
/api/v1/task-recurrences/{uuid}/enable/
Resume a recurring-task series
api_v1_task_recurrences_enable_create 1 param → 200
GET
/api/v1/tasks/
List tasks
api_v1_tasks_list 2 params → 200
POST
/api/v1/tasks/
Create a task
api_v1_tasks_create body → 201
GET
/api/v1/tasks/{uuid}/
Get a task
api_v1_tasks_retrieve 1 param → 200
PUT
/api/v1/tasks/{uuid}/
Update a task
api_v1_tasks_update 1 param body → 200
PATCH
/api/v1/tasks/{uuid}/
Partially update a task
api_v1_tasks_partial_update 1 param body → 200
DELETE
/api/v1/tasks/{uuid}/
Delete a task
api_v1_tasks_destroy 1 param → 204
GET
/api/v1/tasks/{uuid}/attachments/
List task attachments
api_v1_tasks_attachments_retrieve 1 param → 200
POST
/api/v1/tasks/{uuid}/attachments/
List task attachments
api_v1_tasks_attachments_create 1 param body → 200
DELETE
/api/v1/tasks/{uuid}/attachments/{attachment_uuid}/
Delete a task attachment
api_v1_tasks_attachments_destroy 2 params → 204
POST
/api/v1/tasks/{uuid}/plan/approve/
Approve the pending agent plan (version-pinned)
api_v1_tasks_plan_approve_create 1 param body → 200
POST
/api/v1/tasks/{uuid}/plan/reject/
Reject the pending agent plan (task returns to humans, agent unassigned)
api_v1_tasks_plan_reject_create 1 param body → 200
POST
/api/v1/tasks/{uuid}/repeat/
Set, update, or clear a task's recurrence
api_v1_tasks_repeat_create 1 param → 200
DELETE
/api/v1/tasks/{uuid}/repeat/
Set, update, or clear a task's recurrence
api_v1_tasks_repeat_destroy 1 param → 204
POST
/api/v1/tasks/{uuid}/route/
Route a MoR-routed task to a worker (by role)
api_v1_tasks_route_create 1 param body → 200
GET
/api/v1/tasks/{uuid}/route-targets/
List the routable targets for a MoR-routed task
api_v1_tasks_route_targets_retrieve 1 param → 200
GET
/api/v1/tasks/me/
List tasks assigned to current user
api_v1_tasks_me_retrieve → 200
GET
/api/v1/tasks/related-search/
Search linkable related items
api_v1_tasks_related_search_list 2 params → 200

Schemas 38

The contract defines 38 schemas that model the data the API accepts and returns. The most detailed are Task (30 properties), PatchedTask (30 properties), TaskRecurrence (21 properties), PatchedTaskRecurrence (21 properties). Each schema is shown below with its type and property counts.

Task
object
30 properties 21 required
PaginatedTaskList
object
4 properties 2 required
MessageReactionSummary
object
One emoji's aggregated reaction state on a message, for the caller.
4 properties 4 required
MessageAttachmentDispositionEnum
string
sent - Sent suspicious - Suspicious skippedtimeout - Not used (scan pending)
TaskPriorityEnum
string
low - Low medium - Medium high - High urgent - Urgent
PaginatedMessageReadList
object
4 properties 2 required
TaskRecurrence
object
Read/update surface for an existing series (the template's recurrence).
21 properties 9 required
RelatedTargetTypeEnum
string
order - order supplier - supplier buyer - buyer contract - contract ingredient - ingredient task - task
RouteTaskInput
object
Body for POST /tasks/{uuid}/route/ — role-based routing intent. The router agent expresses which role to route to; the backend resolves the concrete user. slug…
2 properties 1 required
UserMinimal
object
5 properties 5 required
MessageAttachmentRef
object
One attachment ref carried on a message's metadata["attachments"] (SC-4146). Channel-neutral and reusable by any message serializer (agent chat today; task cha…
4 properties 4 required
TaskRecurrenceEndsModeEnum
string
never - Never ondate - On date aftercount - After count
RouteTargetsResponse
object
Response shape for GET /tasks/{uuid}/route-targets/ — gives the FE/agent a concrete contract instead of an untyped object (mirrors morrouting.routetargetsforta…
3 properties 3 required
MessageRead
object
11 properties 11 required
ChatThreadEnum
string
main - Main plan - Plan
PatchedTaskRecurrence
object
Read/update surface for an existing series (the template's recurrence).
21 properties
RelatedItemInput
object
One write-side related-item: a target type + entity uuid.
2 properties 2 required
MessageReactionEmojiEnum
string
👍 - Thumbs up 👀 - Eyes ✅ - Check mark ❤️ - Heart 😂 - Tears of joy 🎉 - Party
TaskRecurrenceWeekdayEnum
string
MO - Monday TU - Tuesday WE - Wednesday TH - Thursday FR - Friday SA - Saturday SU - Sunday
TaskAttachment
object
10 properties 6 required
_RouteTargetAgent
object
One installed worker agent option (slug + display name).
2 properties 2 required
TaskRecurrenceFrequencyEnum
string
daily - Daily weekly - Weekly monthly - Monthly yearly - Yearly cron - Cron
TaskAttachmentKindEnum
string
general - General plan - Plan
TaskPlanStatusEnum
string
pendingapproval - Pending Approval approved - Approved rejected - Rejected superseded - Superseded
TargetEnum
string
accountmanager - accountmanager buyeragent - buyeragent moragent - moragent returntobuyer - returntobuyer
_RouteTargetAccountManager
object
Account-manager availability only — the AM's identity is never exposed.
1 property 1 required
PatchedTask
object
30 properties
TaskRecurrenceOverlapPolicyEnum
string
skip - Skip allow - Allow replace - Replace
TaskPlanReject
object
Request body for POST /tasks/{uuid}/plan/reject/. planversion pins the version the user actually reviewed (same contract as approve): a revision landing mid-re…
2 properties 1 required
TaskRecurrenceMonthlyModeEnum
string
dayofmonth - Day of month nthweekday - Nth weekday
TaskAttachmentFileRef
object
Stable handle the agent feeds to getfile MCP tool. Same uuid as TaskAttachment.uuid; the dedicated nested type just keeps the generated FE schema strongly-type…
1 property 1 required
BlankEnum
TaskPlanApproverKindEnum
string
taskparticipants - Task Participants merchantofrecord - Merchant of Record
MessageWrite
object
Validates chat message create input. The viewset drives the write.
6 properties 1 required
TaskStatusEnum
string
open - Open inprogress - In Progress waitingapproval - Waiting Approval done - Done
RelatedTarget
object
A single hit in the task "Related to" search — an order, supplier, buyer, contract, ingredient or another task the caller can link a task to. (buyer is only em…
5 properties 5 required
TaskPlan
object
Read shape of one plan version for the task envelope + decision responses. Deliberately author-less: the plan is presented as authored by the task's assignee,…
9 properties 9 required
TaskPlanApprove
object
Request body for POST /tasks/{uuid}/plan/approve/. planversion pins the version the user actually reviewed — a revision landing mid-review makes the approve 40…
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

opply-tasks-api-openapi.yml Raw ↑

Other APIs Opply publishes across the network.

Opply Activity Feed API
Opply Admin panel API
Opply Agents API
Opply Agreements API
Opply api API
Opply App Orders API
Opply Brain API
Opply Brands API
Opply Buyer Documents API
Opply Buyer Financial Documents API
Opply Buyer Onboarding API
Opply Buyer self-onboarding API
Where this information came from

This is an independent, third-party profile of Opply Tasks API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.