Skip to main content
GET
/
v1
/
dispositions
cURL
curl --request GET \
  --url https://client-api.salesfinity.co/v1/dispositions \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "_id": "<string>",
      "id": 123,
      "name": "<string>",
      "is_custom": true,
      "is_required": true
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.salesfinity.ai/llms.txt

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

Retrieves all dispositions available for your team. Dispositions are call outcome categories used to classify the result of each call. This endpoint returns both default dispositions (built-in) and any custom dispositions your team has created.

Query Parameters

  • is_custom (optional, boolean): Filter by custom or default dispositions
    • true - Only return custom dispositions
    • false - Only return default dispositions
  • category (optional, string): Filter by disposition category
    • positive - Meeting set, referral, callback later, reach out in 6 months, send an email
    • negative - Not interested, do not call again
    • neutral - No longer with company, wrong contact
    • not_answered - No answer, left voicemail, gatekeeper, bad number
    • cancelled - Cancelled calls

Response

Returns a JSON object containing an array of dispositions.
{
  "data": [
    {
      "_id": "507f1f77bcf86cd799439011",
      "id": 1,
      "name": "Answered - Meeting Set",
      "is_custom": false,
      "is_required": true,
      "category": "positive"
    },
    {
      "_id": "507f1f77bcf86cd799439012",
      "id": 2,
      "name": "Answered - No Longer with Company",
      "is_custom": false,
      "is_required": false,
      "category": "neutral"
    }
  ]
}

Response Fields

FieldTypeDescription
_idstringUnique identifier
idnumberDisposition ID (use for filtering call logs)
namestringHuman-readable disposition name
is_custombooleanWhether this is a custom disposition
is_requiredbooleanWhether this disposition is required
categorystringDisposition category

Default Dispositions

IDNameCategory
1Answered - Meeting Setpositive
2Answered - No Longer with Companyneutral
3Answered - Not Interestednegative
4Answered - Referralpositive
5Answered - Wrong Contactneutral
6Answered - Call back laterpositive
7Answered - Reach out in 6 monthspositive
8Answered - Send an emailpositive
9Answered - Do not call againnegative
10No Answernot_answered
11Left Voicemailnot_answered
12Gatekeepernot_answered
13Bad Numbernot_answered
14Cancelledcancelled

Authorizations

x-api-key
string
header
required

Query Parameters

is_custom
boolean

Filter by custom (true) or default (false) dispositions

category
enum<string>

Filter by disposition category

Available options:
positive,
negative,
neutral,
not_answered,
cancelled

Response

200 - application/json

Dispositions retrieved successfully

data
object[]