Tasks

List compliance tasks

Changed on

List compliance tasks with assignments and status so teams can track audit readiness, evidence work, and control implementation.

get/v1/tasks

Request

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

Query parameters

includeRelationsstring

Include controls and automations with runs

Response

Tasks 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 new optional query request parameter includeRelations