Create options

Needs: Staff, Read-write

Returns what the Add staff form needs: the required fields, the roles you can assign, business locations, the staff limit on the current plan, the other fields you can set and the custom attributes on the create form.

Note: Role names, locations, the limit and custom attributes depend on your organisation, so the values shown are placeholders. staff_limit is only included when your plan has one.

curl -X GET "https://app.imploy.com.au/api/integrations/v1/staff/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/staff/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/staff/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/staff/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/staff/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": [
    "email",
    "first_name",
    "last_name",
    "role",
    "address",
    "locations (defaults when there is only one)"
  ],
  "roles": [
    {
      "id": 3,
      "name": "Support Worker"
    }
  ],
  "locations": [
    {
      "id": 1,
      "name": "Example Location"
    }
  ],
  "staff_limit": {
    "limit": 5,
    "current": 2
  },
  "other_fields": [
    "..."
  ],
  "create_form_custom_attributes": [
    "..."
  ],
  "note": "New staff are created as Pending and emailed a link to set their password. People who already have an Imploy login elsewhere need link_existing_accounts."
}