GET
/
tasks
/
{id}
curl --request GET \
  --url https://api.opkit.co/v1/tasks/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "script_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "summary": "<string>",
  "customer_feedback": "<string>",
  "reviewed": true,
  "flagged": true,
  "flagged_reason": "script_deviation",
  "outcome": "success",
  "created_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z",
  "target_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "pending",
  "context": [
    {
      "name": "<string>",
      "description": "<string>",
      "items": [
        {
          "name": "<string>",
          "description": "<string>",
          "items": [
            {
              "name": "<string>",
              "description": "<string>",
              "items": [
                {
                  "name": "<string>",
                  "description": "<string>",
                  "items": [
                    {
                      "name": "<string>",
                      "description": "<string>",
                      "items": [
                        {
                          "name": "<string>",
                          "description": "<string>",
                          "items": [
                            "<any>"
                          ]
                        }
                      ]
                    }
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "objectives": [
    {
      "name": "<string>",
      "description": "<string>",
      "type": "string",
      "enum": [
        "<string>"
      ]
    }
  ],
  "results": [
    {
      "name": "<string>",
      "value": "<string>",
      "type": "string",
      "enum": [
        "<string>"
      ]
    }
  ],
  "duration_seconds": 123
}

Authorizations

Authorization
string
headerrequired

The Opkit API uses the HTTP Bearer Token scheme for authentication. You should provide your API key in the Authorization header like so: "Authorization: Bearer [api-key]".

Path Parameters

id
string
required

Response

200 - application/json
id
string
required
script_id
string
summary
string
customer_feedback
string
reviewed
boolean
required
flagged
boolean
required
flagged_reason
enum<string> | null
Available options:
script_deviation,
inaccurate_results,
missing_results,
other
outcome
enum<string>
Available options:
success,
failure
created_at
string
required
finished_at
string
target_id
string
required
batch_id
string
required
template_id
string
required
status
enum<string>
required
Available options:
pending,
in_progress,
complete,
canceled,
paused
context
object[]
required
objectives
object[]
required
results
object[]
duration_seconds
integer
List All TasksCall Object