Skip to main content
GET
/
v1
/
outcomes
cURL
curl --request GET \
  --url https://api.penciled.com/v1/outcomes \
  --header 'Authorization: Bearer <token>'
{
  "outcomes": {
    "scheduled": "positive",
    "rescheduled": "positive",
    "unconfirmed": "neutral"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.penciled.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Request

​
Query Parameters

  • agent_id (string, required): The ID of the agent.

​
Response

  • outcomes (object of outcomes types): An object where the keys are the outcome, eg “scheduled” and the sentiment value, eg “positive”.
Sentiment values can be one of three options: “positive”, “negative”, or “neutral”

​
Example Response

{
  "outcomes": { "scheduled": "positive", "rescheduled": "positive", "unconfirmed": "neutral", "requested_callback": "negative", "voicemail": "neutral" }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
agent_id
string
required

The ID of the agent

Response

Outcomes response

​
outcomes
object
Example:
{
  "scheduled": "positive",
  "rescheduled": "positive",
  "unconfirmed": "neutral"
}