Create options

Needs: Clients, Read-write

Returns what the Add client form needs, so you can collect every missing detail before creating. It lists the required fields, client types, genders, statuses, the business locations you can use, the other fields you can set and the custom attributes on the create form.

Note: other_fields and create_form_custom_attributes depend on your organisation, so the values shown here are placeholders.

curl -X GET "https://app.imploy.com.au/api/integrations/v1/clients/create-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/clients/create-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/clients/create-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/clients/create-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/clients/create-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

{
  "required": [
    "first_name",
    "last_name",
    "client_type",
    "business_id (location; defaults when there is only one)"
  ],
  "client_types": [
    "HCP",
    "SaH",
    "THCP",
    "GHCP",
    "NDIS",
    "Private"
  ],
  "genders": [
    "Male",
    "Female",
    "Other",
    "Non-binary",
    "Prefer not to say"
  ],
  "statuses": [
    "Active",
    "Inactive",
    "Hospital leave"
  ],
  "locations": [
    {
      "id": 1,
      "name": "Example Location"
    }
  ],
  "other_fields": [
    "..."
  ],
  "create_form_custom_attributes": [
    "..."
  ]
}