Skip to content

Get receiving hours entry details

GET
/v1/receiving-hours/{id}
curl --request GET \
--url https://api2.recruso.co.uk/v1/receiving-hours/1 \
--header 'Authorization: <Authorization>'

Returns one of your agency’s receiving hours entries by id. A receiving hours entry is how a client prefers to receive its workers’ hours — a block timesheet, email, the portal, post, a text message, or from the workers themselves.

You only ever see and change your own agency’s records; there is no owner id on the request, and an id belonging to another agency returns 404 rather than 403 so that its existence is never disclosed.

Access. Requires a client-credentials access token. Tokens issued through the interactive user login are rejected.

id
required
integer format: int32

The id path parameter

OK

Media typeapplication/json
object
receivingHourId
required
integer format: int16
receivingHourName
required
string
Examplegenerated
{
"receivingHourId": 1,
"receivingHourName": "example"
}

Unauthorized

Media typeapplication/problem+json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Forbidden

Media typeapplication/problem+json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Not Found

Media typeapplication/problem+json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}