Tasks API
Fetch open tasks for a supplier connection and use task status to determine Ready to Transact readiness.
Tasks API
The graphiteConnect Tasks API returns all open tasks for a supplier connection. Tasks represent actions that require attention before a supplier relationship is fully operational — such as confirming banking data, completing reviews, or acknowledging profile changes.
Endpoint
GET /api/public/api/v1/tasks
Authentication: Bearer JWT (OAuth 2.0)
Query Parameters
| Parameter | Description |
|---|---|
publicId | The graphiteConnect Public ID of the connected supplier |
limit | Maximum number of results per page (max 1000) — see Pagination |
page | Page number (0-indexed) — see Pagination |
kitId | Filter tasks associated with a specific kit |
kitType | Filter tasks by kit type |
Response
Tasks are returned in JSON format as an array of task objects. Each object includes:
| Field | Description |
|---|---|
_id | Unique identifier for the task |
type | Task type (e.g., acknowledgment, review) |
status | Current status of the task |
kitId | ID of the associated kit, if applicable |
kitType | Type of the associated kit, if applicable |
Task Types and Ready to Transact
Tasks are used to determine whether a supplier is Ready to Transact. Specifically:
acknowledgmenttasks — supplier has data that requires confirmation (e.g., a banking or location change that needs to be acknowledged)reviewtasks — supplier data is under review
If a supplier has any open tasks of type acknowledgment or review, they are not ready to transact. When no such tasks exist, the supplier may be considered ready.
If open tasks of type "acknowledgment" or "review" exist → NOT ready to transact
If no such tasks exist → ready to transact
Pagination
Since a company may accumulate a large number of tasks over time, the Tasks API supports pagination. Use limit and page parameters to page through results, and check the total field in the response to determine the full result count.
See Pagination for full details on pagination parameters.
Example Request
curl --location 'https://poc.projectgraphite.com/api/public/api/v1/tasks?publicId=US1234&limit=100&page=0' \
--header 'Authorization: Bearer <your_access_token>'Related Documentation
- Ready To Transact — Blocked companies and the ERP_Ready_To_Transaction answer key
- Pagination — Pagination query parameters
- Events API — Auditing events for your organization
Updated about 7 hours ago
