Clock in

Needs: Roster, Read-write

Clocks staff in to a published shift now, like Clock in on the roster. A multi-staff shift clocks each person separately. Confirm before calling this.

Errors

422 with <name> is already clocked in. when someone has already clocked in.

curl -X POST "https://app.imploy.com.au/api/integrations/v1/shifts/example_string/clock-in" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "staff_ids": [
    31
  ]
}'

import requests
import json

url = "https://app.imploy.com.au/api/integrations/v1/shifts/example_string/clock-in"
headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
}
data = {
  "staff_ids": [
    31
  ]
}

response = requests.post(url, headers=headers, json=data)
print(response.json())

const response = await fetch("https://app.imploy.com.au/api/integrations/v1/shifts/example_string/clock-in", {
  method: "POST",
  headers: {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
},
  body: JSON.stringify({
  "staff_ids": [
    31
  ]
})
});

const data = await response.json();
console.log(data);

package main

import (
    "fmt"
    "net/http"
    "bytes"
    "encoding/json"
)

func main() {
    data := []byte(`{
  "staff_ids": [
    31
  ]
}`)

    req, err := http.NewRequest("POST", "https://app.imploy.com.au/api/integrations/v1/shifts/example_string/clock-in", bytes.NewBuffer(data))
    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/clock-in')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
request.body = '{
  "staff_ids": [
    31
  ]
}'

response = http.request(request)
puts response.body

{
  "ref": "a:123",
  "succeeded": 1,
  "failed": 0,
  "results": [
    {
      "staff": "Example Worker",
      "ok": true
    }
  ]
}

POST

/shifts/{ref}/clock-in

POST

Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token

Bearer Tokenstring

Required

An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.

path

refstring

Required

The shift ref, such as a:123.

Content-Typestring

Required

The media type of the request body

Options: application/json

staff_idsarray

Required

Staff on the shift to clock in.

Request Preview

Response

Response will appear here after sending the request

Authentication

header

Authorizationstring

Required

Bearer token. An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.

Path Parameters

refstring

Required

The shift ref, such as a:123.

Body

application/json

staff_idsarray

Required

Staff on the shift to clock in.

Responses

Was this page helpful?