Skip to documentation
DocumentationAPI referenceGet operation status
GETBearer token

Get operation status

/api/v1/tasks/:taskKey

Read the durable status of an owned operation. state and supplier taskStatus have distinct meanings. Credentials and wallet signatures are never returned.

Request example

cURL
curl "https://tovahub.com/api/v1/tasks/server%3A507f1f77bcf86cd799439012%3Arestart%3Adocs_example_001" \
  -H "Authorization: Bearer $TOVAHUB_TOKEN"

Examples only. No requests are sent from this page.

Parameters

taskKeyPath · Required

string

8–240 characters: letters, digits, colon, underscore or hyphen. Use the exact returned taskKey.

Response

HTTP status 200

Read the durable status of an existing organization operation.

taskKeystring

Stable platform operation key.

actionstring

Recorded action name.

statestring ('started' | 'succeeded' | 'failed')

Local operation state, distinct from the provider task status.

pendingboolean

True while local or supplier completion remains unresolved.

localFinishPendingboolean

True when a succeeded snapshot request has a saved response, a valid completion time, no supplier task ID and unfinished local acceptance. Use recover_snapshot with the original action and requestKey; task GET remains read-only.

taskIdstring | null

Supplier task identifier, when present.

taskStatusstring | null

Last observed supplier task status.

errorstring | null

Sanitized recorded error, if any.

createdAtstring (ISO 8601)

Local operation creation time.

finishedAtstring (ISO 8601) | null

Local completion time, if present.

actorUserIdstring (ObjectId) | null

Original actor account ID, or null for incomplete history. The current reader must be an active member of the same fixed team.