Tasks
List All Tasks
- Website
- Trust Center
- Introduction
- Tasks
- Calls
- Templates
- Targets
- Batches
- Recordings
- Transcripts
- Scripts
Get Started
API Reference
Tasks
List All Tasks
GET
/
tasks
Authorization
string
*
Bearer
Authorization
Required
string
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]".
after
string
after
string
target_id
string
target_id
string
batch_id
string
batch_id
string
status
enum<string>
status
enum<string>
outcome
enum<string>
outcome
enum<string>
curl --request GET \
--url https://api.opkit.co/v1/tasks \
--header 'Authorization: Bearer <token>'{
"items": [
{
"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
}
],
"count": 123
}Authorizations
Authorization
string
headerrequiredThe 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]".
Query Parameters
after
string
target_id
string
batch_id
string
status
enum<string>
Available options:
pending, in_progress, complete, canceled, paused outcome
enum<string>
Available options:
success, failure Response
200 - application/json
items
object[]
requireditems.id
string
requireditems.script_id
string
items.summary
string
items.customer_feedback
string
items.reviewed
boolean
requireditems.flagged
boolean
requireditems.flagged_reason
enum<string> | null
Available options:
script_deviation, inaccurate_results, missing_results, other items.outcome
enum<string>
Available options:
success, failure items.created_at
string
requireditems.finished_at
string
items.target_id
string
requireditems.batch_id
string
requireditems.template_id
string
requireditems.status
enum<string>
requiredAvailable options:
pending, in_progress, complete, canceled, paused items.context
object[]
requireditems.context.name
string
requireditems.context.description
string
requireditems.context.items
object[]
requireditems.context.items.name
string
requireditems.context.items.description
string
requireditems.context.items.items
object[]
requireditems.context.items.items.name
string
requireditems.context.items.items.description
string
requireditems.context.items.items.items
object[]
requireditems.context.items.items.items.name
string
requireditems.context.items.items.items.description
string
requireditems.context.items.items.items.items
object[]
requireditems.context.items.items.items.items.name
string
requireditems.context.items.items.items.items.description
string
requireditems.context.items.items.items.items.items
object[]
requireditems.context.items.items.items.items.items.name
string
requireditems.context.items.items.items.items.items.description
string
requireditems.context.items.items.items.items.items.items
any[]
requireditems.objectives
object[]
requireditems.objectives.name
string
requireditems.objectives.description
string
requireditems.objectives.type
enum<string>
requiredAvailable options:
string, number, integer, currency, date, time, enum, boolean, js-date-time items.objectives.enum
string[]
items.results
object[]
items.results.name
string
requireditems.results.value
string | null
requireditems.results.type
enum<string>
requiredAvailable options:
string, number, integer, currency, date, time, enum, boolean, js-date-time items.results.enum
string[]
items.duration_seconds
integer
count
integer
requiredcurl --request GET \
--url https://api.opkit.co/v1/tasks \
--header 'Authorization: Bearer <token>'{
"items": [
{
"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
}
],
"count": 123
}