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

Socotra Work Management API

The Work Management API from Socotra — 39 operation(s) for work management.

Socotra Work Management API is one of 18 APIs that Socotra publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 43 operations across 39 paths, and defines 26 schemas. It is described by OpenAPI 3.2.0, at version v0.

Requests are made against a single base URL, /.

43 operations 39 paths 26 schemas 22 GET14 PATCH7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v0
Base URL
https://api.sandbox.socotra.com
Terms of Service
Resource Areas
1

Paths & Operations 43

Across 39 paths, the API surfaces 43 operations — 22 GET, 14 PATCH, 7 POST. Each is listed below with its method, path, parameters, and response codes.

Work Management 43
POST
/work-management/{tenantLocator}/workplans
createWorkplan 1 param body → 200
POST
/work-management/{tenantLocator}/workgroups
createWorkgroup 1 param body → 200
POST
/work-management/{tenantLocator}/userAssociations
makeUserAssociation 1 param body → 200
POST
/work-management/{tenantLocator}/tasks
addTask 1 param body → 200
POST
/work-management/{tenantLocator}/tasks/{locator}/number/set
setTaskNumber 3 params → 200
POST
/work-management/{tenantLocator}/tasks/{locator}/number/generate
generateTaskNumber 2 params → 200
POST
/work-management/{tenantLocator}/assignments
autoAssign 1 param body → 200
GET
/work-management/{tenantLocator}/workplans/{locator}
getWorkplan 2 params → 200
PATCH
/work-management/{tenantLocator}/workplans/{locator}
patchWorkplan 2 params body → 200
PATCH
/work-management/{tenantLocator}/workplans/{locator}/discard
discardWorkplan 2 params → 200
GET
/work-management/{tenantLocator}/workgroups/{workgroupLocator}
getWorkgroup 2 params → 200
PATCH
/work-management/{tenantLocator}/workgroups/{workgroupLocator}
patchWorkgroup 2 params body → 200
PATCH
/work-management/{tenantLocator}/workgroups/{workgroupLocator}/discard
discardWorkgroup 2 params → 200
PATCH
/work-management/{tenantLocator}/userAssociations/{userAssociationLocator}/uncomplete
uncompleteUserAssociation 2 params → 200
PATCH
/work-management/{tenantLocator}/userAssociations/{userAssociationLocator}/disassociate
disassociateUserAssociation 2 params → 200
PATCH
/work-management/{tenantLocator}/userAssociations/{userAssociationLocator}/complete
completeUserAssociation 2 params → 200
GET
/work-management/{tenantLocator}/tasks/{locator}
getTask 2 params → 200
PATCH
/work-management/{tenantLocator}/tasks/{locator}
updateTask 2 params body → 200
PATCH
/work-management/{tenantLocator}/tasks/{locator}/unassign
unassignTask 2 params → 200
PATCH
/work-management/{tenantLocator}/tasks/{locator}/complete
completeTask 2 params → 200
PATCH
/work-management/{tenantLocator}/tasks/{locator}/cancel
cancelTask 2 params → 200
PATCH
/work-management/{tenantLocator}/tasks/{locator}/assign/{userLocator}
assignTask 3 params → 200
PATCH
/work-management/{tenantLocator}/tasks/{locator}/activate
activateTask 2 params → 200
GET
/work-management/{tenantLocator}/qualifications/{userLocator}
getUserQualifications 2 params → 200
PATCH
/work-management/{tenantLocator}/qualifications/{userLocator}
updateUserQualifications 2 params body → 200
GET
/work-management/{tenantLocator}/workplans/list
listWorkplans 3 params → 200
GET
/work-management/{tenantLocator}/workgroups/list
listWorkgroups 4 params → 200
GET
/work-management/{tenantLocator}/userAssociations/{referenceType}/{referenceLocator}/{userAssociationState}/list
listAssignedUsers 6 params → 200
GET
/work-management/{tenantLocator}/userAssociations/{referenceType}/{referenceLocator}/history/list
listReferenceUserAssociationsHistory 5 params → 200
GET
/work-management/{tenantLocator}/userAssociations/{locator}
getUserAssociation 2 params → 200
GET
/work-management/{tenantLocator}/userAssociations/{locator}/history/list
listUserAssociationHistory 4 params → 200
GET
/work-management/{tenantLocator}/userAssociations/user/{userLocator}/{userAssociationState}/list
listUserUserAssociations 5 params → 200
GET
/work-management/{tenantLocator}/userAssociations/user/{userLocator}/qualifiedRoles/list
listUserQualifiedRoles 3 params → 200
GET
/work-management/{tenantLocator}/userAssociations/user/{userLocator}/history/list
listUserUserAssociationsHistory 4 params → 200
GET
/work-management/{tenantLocator}/tasks/{referenceType}/{referenceLocator}/list
searchTasks 5 params → 200
GET
/work-management/{tenantLocator}/tasks/{locator}/history/list
listTaskHistory 4 params → 200
GET
/work-management/{tenantLocator}/tasks/user/{userLocator}/list
listAssignedTasks 4 params → 200
GET
/work-management/{tenantLocator}/tasks/numbers/{taskNumber}
fetchTasksWithNumber 2 params → 200
GET
/work-management/{tenantLocator}/tasks/list
listTasks 3 params → 200
GET
/work-management/{tenantLocator}/tasks/all/list
listAllTasks 3 params → 200
GET
/work-management/{tenantLocator}/qualifications
getQualifications 1 param → 200
GET
/work-management/{tenantLocator}/qualifications/{category}/{level}
fetchUsersQualifications 3 params → 200
GET
/work-management/events
fetchWorkManagementEventDefinitions → 200

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are Task (18 properties), WorkgroupResponse (12 properties), UserAssociation (10 properties), WorkgroupPatchRequest (9 properties). Each schema is shown below with its type and property counts.

WorkplanPatchRequest
object
4 properties 2 required
WorkplanItem
object
8 properties 5 required
WorkgroupResponse
object
12 properties 9 required
UserQualifiedRolesResponse
object
1 property 1 required
TaskCreateRequest
object
8 properties 3 required
UserQualification
object
3 properties 3 required
ListPageResponseTask
object
2 properties 2 required
ListPageResponseUserAssociation
object
2 properties 2 required
WorkgroupCreateRequest
object
6 properties 3 required
WorkplanCreateRequest
object
3 properties 2 required
AutoAssignmentCreateRequest
object
8 properties 2 required
UserAssociationEventData
object
3 properties 3 required
WorkplanItemRequest
object
7 properties 6 required
QualificationsUpdateRequest
object
2 properties 2 required
WorkgroupPatchRequest
object
9 properties 5 required
ListPageResponseWorkplan
object
2 properties 2 required
TaskUpdateRequest
object
8 properties 4 required
UserAssociationCreateRequest
object
4 properties 4 required
UserAssociationEvents
object
4 properties
UserAssociation
object
10 properties 8 required
AutoAssignmentResponse
object
4 properties 4 required
ListPageResponseWorkgroupResponse
object
2 properties 2 required
Task
object
18 properties 8 required
Workplan
object
7 properties 6 required
WorkManagementServiceEventTypeDefinitions
object
1 property 1 required
TaskReference
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

socotra-work-management-api-openapi.yml Raw ↑

Other APIs Socotra publishes across the network.

Socotra Auth API
Socotra Auxdata API
Socotra Billing API
Socotra Business Stats API
Socotra Claim API
Socotra Compliance API
Socotra Config API
Socotra Contact API
Socotra Document API
Socotra Event API
Socotra Migration API
Socotra Payment Execution API
Where this information came from

This is an independent, third-party profile of Socotra Work Management 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.