List sites
Needs: Roster, Read
Lists sites (houses or locations for site shifts) with their status, address, capacity, manager and participants. Participants are the clients a site shift can include. Sorted by name, up to 50 sites.
Note: Fields that have no value, such as
tagsormanager, are left out.
curl -X GET "https://app.imploy.com.au/api/integrations/v1/sites?query=example_string&status=example_string&include_staff=true" \
-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?query=example_string&status=example_string&include_staff=true"
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?query=example_string&status=example_string&include_staff=true", {
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?query=example_string&status=example_string&include_staff=true", 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?query=example_string&status=example_string&include_staff=true')
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
{
"data": [
{
"id": 4,
"name": "Example House",
"type": "Supported Independent Living",
"status": "Active",
"address": "10 Example Rd, Perth WA 6000",
"client_capacity": 4,
"manager": "Example Manager",
"participants": [
{
"id": 12,
"name": "Example Client"
}
],
"support_staff": [
{
"id": 31,
"name": "Example Worker"
}
],
"admin_staff": [
{
"id": 40,
"name": "Example Admin"
}
]
}
]
}
{
"message": "Invalid or expired access token."
}
{
"message": "Access token does not permit this action."
}
{
"message": "Too many requests."
}
/sites
Target server for requests. Edit to use your own host.
An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.
imp_at_. Send it as Authorization: Bearer imp_at_XXXX.Match a site name.
Exact status match, such as Active.
Also include support_staff and admin_staff.
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token. An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.
Query Parameters
Match a site name.
Exact status match, such as Active.
Also include support_staff and admin_staff.
Responses
OK