{ "openapi": "3.0.3", "info": { "description": "This is the API reference for incident.io.\n\nIt documents available API endpoints, provides examples of how to use it, and\ninstructions around things like authentication and error handling.\n\nThe API is hosted at:\n\n- https://api.incident.io/\n\nAnd you will need to create an API key via your [incident.io\ndashboard](https://app.incident.io/settings/api-keys) to make requests.\n\n# Making requests\n\nHere are the key concepts required to make requests to the incident.io API.\n\n## Authentication\n\nFor all requests made to the incident.io API, you'll need an API key.\n\nTo create an API key, head to the incident dashboard and visit [API\nkeys](https://app.incident.io/settings/api-keys). When you create the key, you'll be able to choose what actions it\ncan take for your account: choose carefully, as those roles can only be set\nwhen you first create the key. We'll only show you the token once, so make sure\nyou store it somewhere safe.\n\nAPI keys are global to your incident.io account, and can be managed by anyone\nwho has the right permissions. We display the user that created the API key,\nand the API key will remain valid if that user becomes deactivated.\n\nOnce you have the key, you should make requests to the API that set the\n`Authorization` request header using a \"Bearer\" authentication scheme:\n\n```\nAuthorization: Bearer \n```\n\n## Rate Limits\n\nThe incident.io API enforces rate limits to ensure consistent performance for all users.\n\nThe default rate limit is 1200 requests/minute per API key. This limit applies to most endpoints across the API.\n\nLimits are token buckets that refill continuously rather than resetting on a fixed window boundary. The default\nbucket holds 1200 requests and refills at 20 per second, so you can burst up to the full bucket and then sustain\n20 requests/second indefinitely. There is no boundary at which your quota resets to full in one step.\n\nSome endpoints have lower rate limits, particularly those that interact with external third-party systems that impose\ntheir own limitations. These specific limits vary by endpoint.\n\n### Rate limit headers\n\nResponses to requests authenticated with an API key carry your current allowance, so you can pace yourself rather\nthan waiting to be throttled:\n\n```\nX-RateLimit-Limit: 60, 1200;window=60, 60;window=60\nX-RateLimit-Remaining: 59\nX-RateLimit-Used: 1\nX-RateLimit-Reset: 1785173199\n```\n\n| Header | Meaning |\n| --- | --- |\n| `X-RateLimit-Limit` | The quota that binds this request, followed by every limit that applied and the window it applies over |\n| `X-RateLimit-Remaining` | Requests you can make right now against the binding limit |\n| `X-RateLimit-Used` | Requests you have spent against it |\n| `X-RateLimit-Reset` | Unix timestamp (seconds) at which that limit will be back to full |\n\nMore than one limit can apply to a request: your API key's overall limit, and for some endpoints a lower limit of\ntheir own. `X-RateLimit-Limit` lists all of them, each with its window, so `1200;window=60` means 1200 requests per\nminute. Because our limits refill continuously rather than resetting on a boundary, that window is what tells you\nthe rate you can sustain: 1200 per 60 seconds is 20 requests/second indefinitely.\n\n`Remaining`, `Used` and `Reset` describe whichever limit has the least allowance left, since that is the one you\nwill hit first.\n\n`X-RateLimit-Remaining` may lag by a small number of requests under high concurrency, and can move by more than the\nrequests you made, because limits scoped to your whole organisation are shared with your other API keys.\n\nHeaders are omitted rather than guessed if we cannot determine your allowance for a request.\n\n### Exceeding a rate limit\n\nWhen you exceed a rate limit the API responds with `429 Too Many Requests` and a `Retry-After` header giving the\nnumber of seconds to wait:\n\n```\nX-RateLimit-Limit: 1200, 1200;window=60\nX-RateLimit-Remaining: 0\nX-RateLimit-Used: 1200\nX-RateLimit-Reset: 1785173199\nRetry-After: 1\n```\n\nPrefer `Retry-After` over `X-RateLimit-Reset` when deciding how long to back off. `Retry-After` is when a single\nrequest will succeed; `X-RateLimit-Reset` is the later point at which your whole allowance has returned. It is a\nduration rather than a timestamp, so it does not depend on your clock agreeing with ours.\n\nThe 429 also carries a JSON body with the same information:\n\n```json\n{\n \"type\": \"too_many_requests\",\n \"status\": 429,\n \"request_id\": \"b839a403-7704-41c1-bf6a-39a2d68caefa\",\n \"rate_limit\": {\n \"name\": \"api_key_name\",\n \"limit\": 1200,\n \"remaining\": 0,\n \"retry_after\": \"2025-04-17T11:17:18Z\"\n },\n \"errors\": [\n {\n \"code\": \"too_many_requests\",\n \"message\": \"Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\"\n }\n ]\n}\n```\n\nThe response includes:\n* The name of the API key (`name`)\n* The bucket limit (`limit`)\n* The number of requests remaining (`remaining`)\n* When you can retry requests (`retry_after`), as an RFC3339 timestamp\n\n## Errors\n\nWe use standard HTTP response codes to indicate the status or failure of API\nrequests.\n\nThe API response body will be JSON, and contain more detailed information on the\nnature of the error.\n\nAn example error when a request is made without an API key:\n\n```json\n{\n \"type\": \"authentication_error\",\n \"status\": 401,\n \"request_id\": \"8e3cc412-b49d-4957-9073-2c19d2c61804\",\n \"errors\": [\n {\n \"code\": \"missing_authorization_material\",\n \"message\": \"No authorization material provided in request\"\n }\n ]\n}\n```\n\nNote that the error:\n\n- Contains the HTTP status (`401`)\n- References the type of error (`authentication_error`)\n- Includes a `request_id` that can be provided to incident.io support to help\n\tdebug questions with your API request\n- Provides a list of individual errors, which go into detail about why the error\n\toccurred\n\nThe most common error will be a 422 Validation Error, which is returned when the\nrequest was rejected due to failing validations.\n\nThese errors look like this:\n\n```json\n{\n \"type\": \"validation_error\",\n \"status\": 422,\n \"request_id\": \"631766c4-4afd-4803-997c-cd700928fa4b\",\n \"errors\": [\n {\n \"code\": \"is_required\",\n \"message\": \"A severity is required to open an incident\",\n \"source\": {\n \"field\": \"severity_id\"\n }\n }\n ]\n}\n```\n\nThis error is caused by not providing a severity identifier, which should be at\nthe `severity_id` field of the request payload. Errors like these can be mapped to\nforms, should you be integrating with the API from a user-interface.\n\n## Compatibility\n\nWe won't make breaking changes to existing API services or endpoints, but will\nexpect integrators to upgrade themselves to the latest API endpoints within 3\nmonths of us deprecating the old service.\n\nWe will make changes that are considered backwards compatible, which include:\n\n- Adding new API endpoints and services\n- Adding new properties to responses from existing API endpoints\n- Reordering properties returned from existing API endpoints\n- Adding optional request parameters to existing API endpoints\n- Altering the format or length of IDs\n- Adding new values to enums\n\nIt is important that clients are robust to these changes, to ensure reliable\nintegrations.\n\nAs an example, if you are generating a client using an openapi-generator, ensure\nthe generated client is configured to support unknown enum values, often\nconfigured via the `enumUnknownDefaultCase` parameter.\n\nWhen breaking changes are unavoidable, we'll create a new service version on a\nseparate path, and run them in parallel.\n\nFor example:\n\n- https://api.incident.io/v1/incidents\n- https://api.incident.io/v2/incidents\n\nFor any questions, email support@incident.io.\n", "title": "incident.io", "version": "1.0.0" }, "servers": [ { "url": "https://api.incident.io" } ], "security": [ { "BearerAuth": [] } ], "tags": [ { "description": "View and manage schedules.\nManage your full schedule of on-call rotations, including the users and rotation configuration.\n", "name": "Schedule Entries V2" } ], "paths": { "/v2/schedule_entries": { "get": { "description": "List the schedule entries for a schedule over a window of time.\n\nUse this endpoint to find out who is on-call for a schedule, either right now or\nat any point in the future. Common uses include:\n\n- Building a calendar or timeline view of who is on-call.\n- Looking up who was on-call at a particular moment (for example, when an\n incident fired).\n- Exporting upcoming shifts into another system, such as a payroll or\n scheduling tool.\n\nThe response groups entries into three lists: `scheduled` (the entries the\nrotation rules produce, before any overrides), `overrides` (any one-off\noverrides that apply in the window) and `final` (the effective schedule\nafter overrides have been merged in — this is normally the list you want).\n\nEach entry includes the `rotation_id` and `layer_id` it belongs to.\nSchedules can be made up of multiple rotations (for example, a primary and\na secondary rotation) and each rotation can have several layers, and we\nreturn entries for every rotation and layer on the schedule.\n\nThe endpoint returns all entries that overlap with the given window. If no\nwindow is provided we default to a sensible range starting from now.\n\n## Pagination\n\nResponses are paginated. When more entries are available than fit on a single\npage, the response includes a `pagination_meta` block with two fields:\n\n- `after_url` — a fully-formed URL for the next page. The simplest way\n to paginate is to keep following this URL until it is no longer present.\n- `after` — an opaque cursor token. To fetch the next page manually,\n re-issue the request with `entry_window_start` set to this value and\n `entry_window_end` left unchanged from the original request. Treat\n the token as opaque — do not parse or modify it.\n\nKeep paginating until `pagination_meta` is absent from the response, at\nwhich point you have received every entry in the window.", "operationId": "Schedules V2_ListScheduleEntries", "parameters": [ { "allowEmptyValue": true, "description": "The ID of the schedule to get entries for.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "query", "name": "schedule_id", "required": true, "schema": { "description": "The ID of the schedule to get entries for.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } }, { "allowEmptyValue": true, "description": "The start of the window to get entries for. May also carry an opaque pagination cursor previously returned in `pagination_meta.after` — pass it back here unchanged to fetch the next page (leave `entry_window_end` unchanged from the original request).", "example": "2021-01-01T00:00:00Z", "in": "query", "name": "entry_window_start", "schema": { "description": "The start of the window to get entries for. May also carry an opaque pagination cursor previously returned in `pagination_meta.after` — pass it back here unchanged to fetch the next page (leave `entry_window_end` unchanged from the original request).", "example": "2021-01-01T00:00:00Z", "type": "string" } }, { "allowEmptyValue": true, "description": "The end of the window to get entries for.", "example": "2021-01-01T00:00:00Z", "in": "query", "name": "entry_window_end", "schema": { "description": "The end of the window to get entries for.", "example": "2021-01-01T00:00:00Z", "format": "date-time", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "pagination_meta": { "after": "abc123", "after_url": "abc123" }, "schedule_entries": { "final": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "overrides": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "scheduled": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ] } }, "schema": { "$ref": "#/components/schemas/SchedulesListScheduleEntriesResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "List", "tags": [ "Schedule Entries V2" ], "x-display-name": "List", "x-docs-display-name": "List", "x-docs-group-name": "Schedule Entries V2", "x-docs-resource-type": "ScheduleEntryV2", "x-mint": { "content": "🔑 Requires the `schedules.view` scope." }, "x-rbac-scopes": [ "schedules.view" ] } }, "/v2/schedules/{id}/actions/preview_entries": { "post": { "description": "Preview the schedule entries that would be generated by a proposed schedule configuration.\n\nUse this endpoint before updating a schedule to see who would be on-call if you\nsaved the supplied schedule payload. The request body uses the same `schedule`\npayload shape as Update schedule, so you can send the configuration you intend\nto save without persisting it.\n\nThe response uses the same `schedule_entries` envelope as List schedule entries:\n`scheduled` contains entries produced by the rotation rules, `overrides`\ncontains matching overrides, and `final` contains the effective schedule after\noverrides are applied.\n\nThe preview window is bounded to keep requests predictable. If you ask for more\nthan 91 days, the response is capped to 91 days from `entry_window_start`.", "operationId": "Schedules V2_PreviewScheduleEntries", "parameters": [ { "description": "The ID of the schedule to preview entries for.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "in": "path", "name": "id", "required": true, "schema": { "description": "The ID of the schedule to preview entries for.", "example": "01FDAG4SAP5TYPT98WGR2N7W91", "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "entry_window_end": "2021-01-08T00:00:00Z", "entry_window_start": "2021-01-01T00:00:00Z", "schedule": { "annotations": { "incident.io/terraform/version": "version-of-terraform" }, "config": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "My Rotation", "scheduling_mode": "fair", "users": [ { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "holidays_public_config": { "country_codes": [ "abc123" ] }, "name": "Primary On-call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "America/Los_Angeles" } }, "schema": { "$ref": "#/components/schemas/SchedulesPreviewScheduleEntriesPayloadV2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "schedule_entries": { "final": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "overrides": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "scheduled": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ] } }, "schema": { "$ref": "#/components/schemas/SchedulesPreviewScheduleEntriesResultV2" } } }, "description": "OK response." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "authentication_error: Authentication failed." }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "resource_forbidden: Access to this resource is forbidden for the authenticated user." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_found: The referenced resource could not be found." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "method_not_allowed: The endpoint does not support this operation for the specified resource." }, "406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "not_acceptable: Requested a media type this endpoint does not support." }, "408": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "request_timeout: The request took too long to process.\n\nclient_timeout: The request was cancelled by the client." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "conflict: Request conflicted with current state of the resource, likely a concurrent update." }, "412": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "precondition_failed: A required condition hasn't been met." }, "413": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "payload_too_large: The request payload is too large." }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "validation_error: A required field was not provided, or the provided data was invalid." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\n\nrate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "api_error: Something went wrong and has been reported internally." } }, "summary": "Preview", "tags": [ "Schedule Entries V2" ], "x-docs-display-name": "Preview", "x-docs-group-name": "Schedule Entries V2", "x-docs-resource-type": "ScheduleEntryV2", "x-mint": { "content": "🔑 Requires the `schedules.view` scope." }, "x-rbac-scopes": [ "schedules.view" ] } } }, "components": { "schemas": { "SchedulesListScheduleEntriesResultV2": { "example": { "pagination_meta": { "after": "abc123", "after_url": "abc123" }, "schedule_entries": { "final": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "overrides": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "scheduled": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ] } }, "properties": { "pagination_meta": { "$ref": "#/components/schemas/AfterPaginationMetaResultV2" }, "schedule_entries": { "$ref": "#/components/schemas/ScheduleEntriesListPayloadV2" } }, "required": [ "schedule_entries" ], "type": "object" }, "ErrorResponse": { "example": { "debug": { "message": "Something broke: and something else: and something else", "stacktrace": [ "thing.go:123" ] }, "errors": [ { "code": "trial_expired", "message": "Default incident call link must be a valid URL", "metadata": { "abc123": "abc123" }, "source": { "field": "default_call_url", "pointer": "/settings/default_call_url" } } ], "rate_limit": { "limit": 100, "name": "client_ip", "remaining": 98, "retry_after": "2020-01-01T00:00:00Z" }, "request_id": "2T1p0e3j", "status": 408, "type": "invalid_request_error" }, "properties": { "debug": { "$ref": "#/components/schemas/ErrorDebug" }, "errors": { "description": "List of errors that caused this request to fail", "example": [ { "code": "trial_expired", "message": "Default incident call link must be a valid URL", "metadata": { "abc123": "abc123" }, "source": { "field": "default_call_url", "pointer": "/settings/default_call_url" } } ], "items": { "$ref": "#/components/schemas/ErrorSingle" }, "type": "array" }, "rate_limit": { "$ref": "#/components/schemas/ErrorRateLimit" }, "request_id": { "description": "Unique identifier of the request", "example": "2T1p0e3j", "type": "string" }, "status": { "description": "HTTP status of the response", "example": 408, "format": "int64", "type": "integer" }, "type": { "description": "Machine-readable identifier for the general category of error", "enum": [ "invalid_request_error", "authentication_error", "resource_forbidden", "not_found", "not_acceptable", "method_not_allowed", "request_timeout", "conflict", "precondition_failed", "payload_too_large", "validation_error", "too_many_requests", "api_error", "rate_limit_reached", "client_timeout" ], "example": "invalid_request_error", "type": "string" } }, "required": [ "type", "status", "request_id", "errors" ], "type": "object" }, "SchedulesPreviewScheduleEntriesPayloadV2": { "example": { "entry_window_end": "2021-01-08T00:00:00Z", "entry_window_start": "2021-01-01T00:00:00Z", "schedule": { "annotations": { "incident.io/terraform/version": "version-of-terraform" }, "config": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "My Rotation", "scheduling_mode": "fair", "users": [ { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "holidays_public_config": { "country_codes": [ "abc123" ] }, "name": "Primary On-call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "America/Los_Angeles" } }, "properties": { "entry_window_end": { "description": "The end of the window to preview entries for. Defaults to four weeks after entry_window_start.", "example": "2021-01-08T00:00:00Z", "format": "date-time", "type": "string" }, "entry_window_start": { "description": "The start of the window to preview entries for. Defaults to now.", "example": "2021-01-01T00:00:00Z", "format": "date-time", "type": "string" }, "schedule": { "$ref": "#/components/schemas/ScheduleUpdatePayloadV2" } }, "required": [ "schedule" ], "type": "object" }, "SchedulesPreviewScheduleEntriesResultV2": { "example": { "schedule_entries": { "final": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "overrides": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "scheduled": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ] } }, "properties": { "schedule_entries": { "$ref": "#/components/schemas/ScheduleEntriesListPayloadV2" } }, "required": [ "schedule_entries" ], "type": "object" }, "AfterPaginationMetaResultV2": { "example": { "after": "abc123", "after_url": "abc123" }, "properties": { "after": { "description": "The time, if it exists, of the last entry's end time", "example": "abc123", "type": "string" }, "after_url": { "description": "The URL to fetch the next page of entries", "example": "abc123", "type": "string" } }, "required": [ "after", "after_url" ], "type": "object" }, "ScheduleEntriesListPayloadV2": { "description": "The schedule entries for a window of time, grouped by where they come from.\n\n`scheduled` are the entries produced by the schedule's rotation rules before\nany overrides are taken into account. `overrides` are the one-off changes that\napply within the window. `final` is the effective schedule after overrides\nhave been merged in — this is normally the list to use when working out who\nis on-call.", "example": { "final": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "overrides": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "scheduled": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ] }, "properties": { "final": { "description": "The effective schedule after overrides have been merged in", "example": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "items": { "$ref": "#/components/schemas/ScheduleEntryV2" }, "type": "array" }, "overrides": { "description": "Overrides that apply within the requested window", "example": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "items": { "$ref": "#/components/schemas/ScheduleEntryV2" }, "type": "array" }, "scheduled": { "description": "Entries from the schedule's rotation rules, before overrides are applied", "example": [ { "end_at": "2021-08-17T13:28:57.801578Z", "entry_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "fingerprint": "01G0J1EXE7AXZ2C93K61WBPYEH", "layer_id": "01G0J1EXE7AXZ2C93K61WBPYNH", "rotation_id": "01G0J1EXE7AXZ2C93K61WBPYEH", "start_at": "2021-08-17T13:28:57.801578Z", "user": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" } } ], "items": { "$ref": "#/components/schemas/ScheduleEntryV2" }, "type": "array" } }, "required": [ "scheduled", "overrides", "final" ], "type": "object" }, "ErrorDebug": { "example": { "message": "Something broke: and something else: and something else", "stacktrace": [ "thing.go:123" ] }, "properties": { "message": { "description": "Original internal error message", "example": "Something broke: and something else: and something else", "type": "string" }, "stacktrace": { "description": "Stacktrace of the error, if applicable", "example": [ "thing.go:123" ], "items": { "example": "thing.go:123", "type": "string" }, "type": "array" } }, "required": [ "message", "stacktrace" ], "type": "object" }, "ErrorSingle": { "example": { "code": "trial_expired", "message": "Default incident call link must be a valid URL", "metadata": { "abc123": "abc123" }, "source": { "field": "default_call_url", "pointer": "/settings/default_call_url" } }, "properties": { "code": { "description": "Machine-readable identifier for this specific error", "example": "trial_expired", "type": "string" }, "message": { "description": "Human readable description of the error", "example": "Default incident call link must be a valid URL", "type": "string" }, "metadata": { "additionalProperties": { "example": "abc123", "type": "string" }, "description": "Additional metadata about the error, keyed by a string identifier", "example": { "abc123": "abc123" }, "type": "object" }, "source": { "$ref": "#/components/schemas/ErrorSource" } }, "required": [ "code", "message" ], "type": "object" }, "ErrorRateLimit": { "example": { "limit": 100, "name": "client_ip", "remaining": 98, "retry_after": "2020-01-01T00:00:00Z" }, "properties": { "limit": { "description": "The maximum number of requests that the consumer is permitted to make per minute", "example": 100, "format": "int64", "type": "integer" }, "name": { "description": "Which rate limit was exceeded", "example": "client_ip", "type": "string" }, "remaining": { "description": "The number of requests remaining in the current rate limit window", "example": 98, "format": "int64", "type": "integer" }, "retry_after": { "description": "When the client can retry, as an RFC3339 timestamp in UTC. Prefer the Retry-After response header, which carries the same instant as a number of seconds", "example": "2020-01-01T00:00:00Z", "type": "string" } }, "required": [ "name", "limit", "remaining", "retry_after" ], "type": "object" }, "ScheduleUpdatePayloadV2": { "example": { "annotations": { "incident.io/terraform/version": "version-of-terraform" }, "config": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "My Rotation", "scheduling_mode": "fair", "users": [ { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "holidays_public_config": { "country_codes": [ "abc123" ] }, "name": "Primary On-call Schedule", "team_ids": [ "01JPQA75EPNEES4479P16P4XAB" ], "timezone": "America/Los_Angeles" }, "properties": { "annotations": { "additionalProperties": { "example": "abc123", "type": "string" }, "description": "Annotations that can track metadata about the schedule", "example": { "incident.io/terraform/version": "version-of-terraform" }, "type": "object" }, "config": { "$ref": "#/components/schemas/ScheduleConfigUpdatePayloadV2" }, "holidays_public_config": { "$ref": "#/components/schemas/ScheduleHolidaysPublicConfigPayloadV2" }, "name": { "description": "Name of the schedule", "example": "Primary On-call Schedule", "type": "string" }, "team_ids": { "description": "IDs of teams that own this schedule", "example": [ "01JPQA75EPNEES4479P16P4XAB" ], "items": { "example": "abc123", "type": "string" }, "type": "array" }, "timezone": { "description": "Timezone of the schedule", "example": "America/Los_Angeles", "type": "string" } }, "type": "object" }, "ScheduleEntryV2": { "description": "A single shift on a schedule, representing who is on-call between a start\nand end time. When present, `rotation_id` and `layer_id` tell you which\nrotation and which layer within that rotation the entry belongs to. A\nschedule may have multiple rotations (for example, a primary and a secondary\nrotation) and each rotation can be made up of several layers — entries are\nreturned for every rotation and layer on the schedule.\n\nEntries come from two places: they are either generated from a schedule's\nrotation configuration (the regular pattern of who is on-call) or created by\nan override (a one-off change that replaces the normal rotation for a period\nof time). When you call the List schedule entries endpoint we return both\nkinds separately, along with the merged `final` schedule that reflects what\nwill actually happen.\n\n`entry_id` is only populated for entries that correspond to a stored\nrecord. Scheduled entries are projections computed from the rotation rules\non the fly and don't have a persisted ID, so `entry_id` will be absent for\nthose. Use `fingerprint` if you need a stable identifier to deduplicate or\ndiff a shift across requests.", "properties": { "end_at": { "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "entry_id": { "description": "Unique identifier of the schedule entry", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "fingerprint": { "description": "A unique identifier for this entry, used to determine a unique shift", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "layer_id": { "description": "If present, the layer this entry applies to on the rotation", "example": "01G0J1EXE7AXZ2C93K61WBPYNH", "type": "string" }, "rotation_id": { "description": "If present, the rotation this entry applies to on the schedule", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "start_at": { "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "user": { "$ref": "#/components/schemas/UserV2" } }, "required": [ "start_at", "end_at" ], "type": "object" }, "ErrorSource": { "example": { "field": "default_call_url", "pointer": "/settings/default_call_url" }, "properties": { "field": { "description": "Field name that is the source of the error", "example": "default_call_url", "type": "string" }, "pointer": { "description": "JSON pointer to the request field that is the source of the error", "example": "/settings/default_call_url", "type": "string" } }, "required": [ "field", "pointer" ], "type": "object" }, "ScheduleConfigUpdatePayloadV2": { "example": { "rotations": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "My Rotation", "scheduling_mode": "fair", "users": [ { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ] }, "properties": { "rotations": { "example": [ { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "My Rotation", "scheduling_mode": "fair", "users": [ { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] } ], "items": { "$ref": "#/components/schemas/ScheduleRotationUpdatePayloadV2" }, "type": "array" } }, "type": "object" }, "ScheduleHolidaysPublicConfigPayloadV2": { "example": { "country_codes": [ "abc123" ] }, "properties": { "country_codes": { "description": "ISO 3166-1 alpha-2 country codes for the countries that this schedule is configured to view holidays for", "example": [ "abc123" ], "items": { "example": "abc123", "type": "string" }, "type": "array" } }, "required": [ "country_codes" ], "type": "object" }, "UserV2": { "example": { "email": "lisa@incident.io", "id": "01FCNDV6P870EA6S7TK1DSYDG0", "name": "Lisa Karlin Curtis", "role": "owner", "slack_user_id": "U02AYNF2XJM" }, "properties": { "email": { "description": "Email address of the user.", "example": "lisa@incident.io", "type": "string" }, "id": { "description": "Unique identifier of the user", "example": "01FCNDV6P870EA6S7TK1DSYDG0", "type": "string" }, "name": { "description": "Name of the user", "example": "Lisa Karlin Curtis", "type": "string" }, "role": { "description": "DEPRECATED: Role of the user as of March 9th 2023, this value is no longer updated.", "enum": [ "viewer", "responder", "administrator", "owner", "unset" ], "example": "owner", "type": "string" }, "slack_user_id": { "description": "Slack ID of the user", "example": "U02AYNF2XJM", "type": "string" } }, "required": [ "role", "id", "name" ], "type": "object" }, "ScheduleRotationUpdatePayloadV2": { "example": { "effective_from": "2021-08-17T13:28:57.801578Z", "handover_start_at": "2021-08-17T13:28:57.801578Z", "handovers": [ { "interval": 1, "interval_type": "hourly" } ], "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "layers": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "name": "My Rotation", "scheduling_mode": "fair", "users": [ { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } ], "working_interval": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "working_intervals": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ] }, "properties": { "effective_from": { "description": "When this version of the rotation takes effect. A rotation can appear multiple times in `rotations` with the same `id` to schedule changes ahead of time: each version applies from its `effective_from` until the next version's. Leave it unset on a rotation's first or only version.", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "handover_start_at": { "description": "Determines when shifts change hands and who takes them: the first user in `users` comes on shift at this time, handing over to the next user after each `handovers` interval, cycling through the list — for example, weekly handovers from a Monday 09:00 give week-long shifts that change hands on Mondays at 09:00.", "example": "2021-08-17T13:28:57.801578Z", "format": "date-time", "type": "string" }, "handovers": { "description": "The cadence shifts hand over on. With more than one entry, the intervals apply in turn — for example, one day then three days produces alternating one-day and three-day shifts.", "example": [ { "interval": 1, "interval_type": "hourly" } ], "items": { "$ref": "#/components/schemas/ScheduleRotationHandoverV2" }, "type": "array" }, "id": { "description": "Unique identifier of the rotation", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "layers": { "example": [ { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" } ], "items": { "$ref": "#/components/schemas/ScheduleLayerUpdatePayloadV2" }, "type": "array" }, "name": { "description": "Name of the rotation", "example": "My Rotation", "type": "string" }, "scheduling_mode": { "description": "Scheduling algorithm to use for this rotation. 'fair' balances workload by considering handover duration, while 'sequential' uses simple round-robin rotation through users. Only applies when you have asymmetric handovers (e.g., 2 days then 5 days).", "enum": [ "fair", "sequential" ], "example": "fair", "type": "string" }, "users": { "description": "The people in the rotation, in the order they take shifts.", "example": [ { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" } ], "items": { "$ref": "#/components/schemas/UserReferencePayloadV2" }, "type": "array" }, "working_interval": { "description": "DEPRECATED: Use working_intervals instead.", "example": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "items": { "$ref": "#/components/schemas/ScheduleRotationWorkingIntervalV2" }, "type": "array" }, "working_intervals": { "example": [ { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" } ], "items": { "$ref": "#/components/schemas/ScheduleRotationWorkingIntervalV2" }, "type": "array" } }, "type": "object" }, "ScheduleRotationHandoverV2": { "example": { "interval": 1, "interval_type": "hourly" }, "properties": { "interval": { "example": 1, "format": "int64", "type": "integer" }, "interval_type": { "description": "How often a handover occurs", "enum": [ "hourly", "daily", "weekly" ], "example": "hourly", "type": "string", "x-public-api-version": "v2" } }, "required": [ "interval_type", "interval" ], "type": "object" }, "ScheduleLayerUpdatePayloadV2": { "example": { "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "name": "Layer 1" }, "properties": { "id": { "description": "Unique identifier of the layer", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "name": { "description": "Name of the layer", "example": "Layer 1", "type": "string" } }, "type": "object" }, "UserReferencePayloadV2": { "example": { "email": "bob@example.com", "id": "01G0J1EXE7AXZ2C93K61WBPYEH", "slack_user_id": "USER123" }, "properties": { "email": { "description": "The user's email address, matching the email on their Slack account", "example": "bob@example.com", "type": "string" }, "id": { "description": "The incident.io ID of a user", "example": "01G0J1EXE7AXZ2C93K61WBPYEH", "type": "string" }, "slack_user_id": { "description": "The ID of the user's Slack account.", "example": "USER123", "type": "string" } }, "type": "object" }, "ScheduleRotationWorkingIntervalV2": { "example": { "end_time": "17:00", "start_time": "09:00", "weekday": "monday" }, "properties": { "end_time": { "description": "End time of the interval, in 24hr format", "example": "17:00", "type": "string" }, "start_time": { "description": "Start time of the interval, in 24hr format", "example": "09:00", "type": "string" }, "weekday": { "description": "Weekdays for use with a schedule", "enum": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ], "example": "monday", "type": "string", "x-public-api-version": "v2" } }, "required": [ "weekday", "start_time", "end_time" ], "type": "object" } }, "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "description": "API key from your incident.io dashboard (Settings → API keys)" } } } }