Skip to main content

Export

The query parameter ids takes ids separated by commas; empty exports every item. The response is a bundle:
An item keeps its definition but no id or organization. References are names: user is the user’s email; team, schedule, policy, and calendar are the names of a team, an on-call schedule, an escalation policy, and a holiday calendar; the members of a rotation are emails. A schedule leaves out its temporary coverage and its times; a routing rule leaves out its position and times.

Import

Each item is matched by name: a new name is created, a name with one item compared field by field, and a name with several items fails, as does a name the file gives twice. Every reference must name something in the organization, and each item is checked as saving it checks it. When any item fails, nothing is written; otherwise the items are written one after another, a federation change event is sent for each synchronized one, and one audit event is recorded: escalation_policies.imported, schedules.imported, or routing_rules.imported.
  • Importing a schedule that exists keeps its temporary coverage and shift swaps.
  • Imported routing rules go first, in the order of the file; the other rules keep their order after them.
action is create, update, unchanged, skip (an existing item with create_only), or error; id is the item created or updated once written. applied says whether anything was written. Errors
Last modified on October 31, 2026