Skip to main content
GET
Get one routine

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Query Parameters

extend
enum<string>[]

Extend options (JSON-encoded array, e.g. ?extend=["category"]):

  • "assigned-to": Resolves the assigned user, provider contact and contract.
  • "compliances": Include the linked compliances (id, type, dueAt).
  • "counts": Adds _count of linked compliances and interventions.
  • "actions-info": Adds actions { canBeUpdated, canBeArchived, canBeUnarchived, canBeDeleted }.
  • "contract": Resolves the linked contract plus its latest document due date.
  • "sites": Adds sites - the deduped units linked via site-compliances.
  • "users": Adds users - the deduped users linked via user-compliances.
  • "rule": Adds rules (deduped, via compliances) and rulesCount.
  • "technical-installations": Adds the deduped technical installations covered by the routine (via compliances → rules), with presigned images.
  • "establishment-cell": Adds establishments - the deduped parent units of any linked cell.
  • "interventions": Adds lastIntervention (most recent past) and nextIntervention (soonest upcoming).
Available options:
assigned-to,
compliances,
counts,
actions-info,
contract,
sites,
users,
rule,
technical-installations,
establishment-cell,
interventions

Response

Default Response

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
ref
string
required
Maximum string length: 40
Pattern: ^[A-Z]+-[1-9]\d*(?:-[A-Z]+-[1-9]\d*)*$
name
string
required
Required string length: 1 - 150
description
string | null
required
Maximum string length: 1000
type
enum<string>
required
Available options:
preventive,
training_session,
training_exercise,
training_qualification
autoCreateEnabled
boolean
required
autoAttachEnabled
boolean
required
rrule
string
required
Required string length: 1 - 500
dateKind
enum<string>
required
Available options:
scheduled,
deadline
archivedAt
string<date-time> | null
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
assignedUser
object | null
assignedContact
object | null
contract
object | null
compliances
object[]
_count
object
actions
object
sites
object[]
users
object[]
rules
object[]
rulesCount
integer
Required range: 0 <= x <= 9007199254740991
technicalInstallations
object[]
establishments
object[]
lastIntervention
object | null
nextIntervention
object | null