Get a shift
Needs: Roster, Read
Returns one shift in full: times, address, clients, staff, services, segments, check-in and check-out, cancellation, recurrence, funding, group charge split and shift notes. Pay rates and costs are not included.
Note: The response also carries the shift's other stored details, such as its times and address. Group and site shifts add
siteandclient_charge_split. Each segment lists itsid,start,end,service,staffand its ownshift_notes, and you use the segment ids to write per-segment notes.
curl -X GET "https://app.imploy.com.au/api/integrations/v1/shifts/example_string" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN"
import requests
import json
url = "https://app.imploy.com.au/api/integrations/v1/shifts/example_string"
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/shifts/example_string", {
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/shifts/example_string", 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/shifts/example_string')
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": {
"ref": "a:123",
"type": "single",
"status": "scheduled",
"clients": [
{
"id": 12,
"name": "Example Client"
}
],
"staff": [
{
"id": 31,
"name": "Example Worker"
}
],
"services": [
{
"staff": "Example Worker",
"service": "Assistance With Self-Care Activities - Standard - Weekday Daytime"
}
],
"segments": [],
"shift_notes": []
}
}
{
"message": "Invalid or expired access token."
}
{
"message": "Access token does not permit this action."
}
{
"message": "Record not found.",
"error": "Record not found."
}
{
"message": "Too many requests."
}
/shifts/{ref}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.The shift ref, such as a:123 or g:456.
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.
Path Parameters
The shift ref, such as a:123 or g:456.
Responses
OK