Penny BankingPlatformTasks

Get a task

Retrieve a long-running operation you started, such as an account deletion, by its ID.

Required permissions: task:read.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

task_idstringRequired
The ID of the background task.

Headers

X-Penny-As-Businessstring or nullOptional

Act on behalf of another business that has granted you access. Requires the business:act_as permission.

Response

The task.
task_idstring
Penny's unique identifier for this task.
versioninteger
A number that increases each time this task's details change. Use it to confirm you are looking at the latest information.
version_timedatetime
The date and time this task's details were last changed.
business_idstring
The business this task was run for.
statusenum

This task’s current status: ‘received’, ‘scheduled’, ‘pending’, ‘pending_subtasks’, ‘running’, ‘failed’, ‘completed’, or ‘cancelled’.

source_referenceobject or nullOptional
The object that scheduled this task, if one is known.
scheduled_timedatetime or nullOptional
When this task is scheduled to run.
start_timedatetime or nullOptional
When this task started running.
finished_timedatetime or nullOptional
When this task finished running.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error