List lead status options

GET

/api/v1/dealerships/{dealership_slug}/lead_status_options

const url = 'https://dashboard.dealerstudio.com.au/api/v1/dealerships/example/lead_status_options';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://dashboard.dealerstudio.com.au/api/v1/dealerships/example/lead_status_options \
  --header 'Authorization: Bearer <token>'

Authorizations

Bearer

Parameters

Path Parameters

dealership_slug

required

string

Dealership Slug

Responses

200

Lead status options found

application/json

Array<object>

object

required

integer

name

required

string

colour_name

required

string

status_type

required

string

active

required

boolean

position

required

integer

colour_class_name

required

string

pipeline

required

object

integer

name

string

Example

[
  {
    "id": 1,
    "name": "New Lead",
    "colour_name": "blue",
    "status_type": "hot",
    "active": true,
    "position": 1,
    "colour_class_name": "bg-blue-500",
    "pipeline": {
      "id": 123,
      "name": "Sales Pipeline"
    }
  }
]

401

Unauthorized

403

Forbidden

404

Dealership not found