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

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
context
object[]
required
  • Option 1

  • Option 2

created_at
string
required
customer_feedback
string
duration_seconds
integer
finished_at
string
id
string
required
objectives
object[]
required
results
object[]
status
enum<string>
required
Available options:
pending,
in_progress,
complete
task_id
string
required