Tasks

Get task by ID

Changed on

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

get/v1/tasks/{taskId}

Request

  • Base URL
    https://api.betayum.com
  • URL
    https://api.betayum.com/v1/tasks/{taskId}
  • Auth
    API key in header X-API-Key

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

  • 36253e8a5c1bRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

  • 946edaa856a9Revision changes
    • warning

      deleted the header request parameter X-Organization-Id

    • info

      added the non-success response with the status