Prospect options

Needs: Prospects, Read

Returns the prospect stages (with whether each needs a follow-up date or a staff member, and its tags), the funding types, consultant staff, the visible custom attribute definitions, and the saved view filter fields.

Note: Stages, staff and custom attributes depend on your organisation, so the values shown are examples.

curl -X GET "https://app.imploy.com.au/api/integrations/v1/prospects/options" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

import requests
import json

url = "https://app.imploy.com.au/api/integrations/v1/prospects/options"
headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch("https://app.imploy.com.au/api/integrations/v1/prospects/options", {
  method: "GET",
  headers: {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
}
});

const data = await response.json();
console.log(data);

package main

import (
    "fmt"
    "net/http"
)

func main() {

    req, err := http.NewRequest("GET", "https://app.imploy.com.au/api/integrations/v1/prospects/options", nil)
    if err != nil {
        panic(err)
    }

    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    fmt.Println("Response Status:", resp.Status)
}

require 'net/http'
require 'json'

uri = URI('https://app.imploy.com.au/api/integrations/v1/prospects/options')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'

response = http.request(request)
puts response.body

{
  "stages": [
    {
      "id": 1,
      "name": "New",
      "requires_date": false,
      "requires_staff": false,
      "tags": []
    }
  ],
  "funding_types": [
    "HCP",
    "NDIS",
    "CHSP",
    "Private"
  ],
  "staff": [
    {
      "id": 40,
      "name": "Example Consultant"
    }
  ],
  "custom_attributes": [
    "..."
  ],
  "view_fields": [
    "prospect_name",
    "prospect_email"
  ],
  "view_group_by": [
    "stage",
    "consultant",
    "fundingType",
    "source"
  ],
  "view_operators": [
    "contains",
    "does_not_contain",
    "starts_with",
    "ends_with",
    "is",
    "is_not",
    "empty",
    "not_empty"
  ]
}