v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

MetaData of the opportunities

Gives MetaData of the Opportunities which can be needed while creating an opportunity. Different sections under metadata are :

Priorities.
Dispositions.
Stages.
Sources.
Types

get/v1/opportunities/metadata/{section}

Path parameters

section'1' | '2' | '3' | '4' | '5' required

Headers

Authorizationstring

Response

200

typesstring[]

Example response

{
  "priorities": [
    {
      "id": "f3283842-729e-469c-8539-818d179bb480",
      "name": "Medium",
      "priority": 1
    }
  ],
  "stages": [
    {
      "id": "75a445fd-5967-429c-83dc-9040244cfbb5",
      "name": "Lead",
      "code": "Lead",
      "active": true
    }
  ],
  "lead_sources": [
    {
      "id": "48f47090-9907-4b1e-8d5d-0821bb5ae1c8",
      "name": "Survey",
      "code": "Test2",
      "active": true
    }
  ],
  "dispositions": [
    {
      "id": "9ff291f0-cf1c-4eaa-ba9a-ee68fc01fa30",
      "name": "Test 1",
      "description": "Test 1",
      "followup_days": 2
    }
  ],
  "types": [
    "Memberships"
  ]
}