Sign in
Tasks

Get task by ID

Get task by ID in Betayum. Manage compliance task lifecycle, assignments, review approvals, evidence uploads, policy links, and activity history.

get/v1/tasks/{taskId}

Path parameters

taskIdstring required
Example:tsk_abc123def456

Unique task identifier

Response

Task retrieved successfully

idstring required

Unique identifier for the task

titlestring required

Task title

descriptionstring

Task description

status'todo' | 'in_progress' | 'done' | 'blocked' required

Task status

createdAtstring date-time required

Task creation timestamp

updatedAtstring date-time required

Task last update timestamp

taskTemplateIdobject nullable

Task template ID

integrationScheduleFrequency'daily' | 'weekly' | 'monthly' | 'quarterly' | 'yearly' required

Cadence for running the integration check attached to this task

integrationLastRunAtobject nullable

Last successful integration check run timestamp

Example response

{
  "id": "tsk_abc123def456",
  "title": "Implement user authentication",
  "description": "Add OAuth 2.0 authentication to the platform",
  "status": "in_progress",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z",
  "integrationScheduleFrequency": "daily"
}

Changes

Changed in 2 of the 51 revisions of this API.13

  • 36253e8a5c1b2See the full diff
    • ○

      added the optional property integrationLastRunAt to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property integrationScheduleFrequency to the response with the 200 status

      response-required-property-added

  • 946edaa856a911See the full diff
    • ●

      deleted the header request parameter X-Organization-Id

      request-parameter-removed

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog