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 System Tasks API

The System Tasks API from Opply — 5 operation(s) for system tasks.

Opply System 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 System Tasks. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 5 paths, and defines 14 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.

5 operations 5 paths 14 schemas 2 GET3 POST

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 System 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 5

Across 5 paths, the API surfaces 5 operations — 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

System Tasks 5
GET
/api/v1/system-tasks/definitions/
List system-task definitions with rollup
api_v1_system_tasks_definitions_list 1 param → 200
POST
/api/v1/system-tasks/definitions/{key}/state/
Pause or resume all tenant series for a system-task definition
api_v1_system_tasks_definitions_state_create 1 param body → 200
POST
/api/v1/system-tasks/recurrences/{recurrence_uuid}/state/
Pause or resume a tenant's system-task series
api_v1_system_tasks_recurrences_state_create 1 param body → 200
POST
/api/v1/system-tasks/sync/
Run a system-task fan-out and return a result summary
api_v1_system_tasks_sync_create body → 200
GET
/api/v1/system-tasks/tasks/
List per-tenant series (schedule + gate + occurrences) for a system-task definition
api_v1_system_tasks_tasks_list 2 params → 200

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are SystemTaskInstance (32 properties), SystemTaskDefinitionRollup (13 properties), SystemTaskTenant (7 properties), SystemTaskSchedule (7 properties). Each schema is shown below with its type and property counts.

SystemTaskGateStatus
object
Pre-run gate observability read off the tenant's TaskRecurrence (see systemtasks/gate.py). Present even when the gate keeps skipping and no occurrence is ever…
5 properties 5 required
UserMinimal
object
5 properties 5 required
TaskStatusEnum
string
open - Open inprogress - In Progress waitingapproval - Waiting Approval done - Done
SystemTaskTenant
object
One installed tenant's series for the drill-in: schedule + gate state + latest-run summary + its occurrence history. The tenant is the primary unit here (not t…
7 properties 7 required
SystemTaskStateRequest
object
Body for the pause/resume actions — isenabled=false pauses, true resumes (recomputing the next slot from now). Shared by the per-tenant and the definition-leve…
1 property 1 required
SystemTaskDefinitionRollup
object
Rollup for one system-task definition, scoped to the caller.
13 properties 13 required
SystemTaskSyncRequest
object
Optional scoping for an on-demand fan-out. Omit both to sync everything. Declared so the generated OpenAPI client documents the request body — the view reads k…
2 properties
SystemTaskSyncResult
object
Counts returned by an on-demand fan-out (the Sync buttons).
4 properties 4 required
SystemTaskDefinitionStateResult
object
Result of the definition-level (bulk) pause/resume: the resulting enabled state for the definition plus how many tenant series were actually flipped.
3 properties 3 required
SystemTaskInstance
object
A system-task occurrence with its owning tenant + latest agent-run status. latestrunstatus (read from a queryset annotation) lets the FE filter by the agent-ru…
32 properties 23 required
_CompanyRef
object
2 properties 2 required
SystemTaskSchedule
object
The tenant's recurrence rule, so the drill-in can show when it runs. recurrenceuuid is the target for the MoR-scoped pause/resume action (SystemTaskRecurrenceS…
7 properties 7 required
TaskPriorityEnum
string
low - Low medium - Medium high - High urgent - Urgent
RelatedItemInput
object
One write-side related-item: a target type + entity uuid.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

opply-system-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 System 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.