Create options

Needs: Roster, Read-write

Returns what the Add site form needs: the required fields, the business locations, the statuses and the other fields you can set. Call it before creating a site, so you can ask for anything missing in one go.

Note: location_id is only listed as required when the organisation has more than one business location.

curl -X GET "https://app.imploy.com.au/api/integrations/v1/sites/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/sites/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/sites/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/sites/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/sites/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": [
    "name",
    "address",
    "location_id (this organisation has several business locations; ask which one)"
  ],
  "locations": [
    {
      "id": 1,
      "name": "Example Location"
    }
  ],
  "statuses": [
    "Active",
    "Inactive",
    "Maintenance"
  ],
  "other_fields": [
    "type",
    "manager_id",
    "email",
    "phone",
    "client_capacity",
    "maximum_staff",
    "description",
    "tags",
    "participants",
    "support_staff",
    "admin_staff"
  ]
}