{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-demand/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"Integrate the Status API","siteUrl":"https://developers.booking.com"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"integrate-the-status-api","__idx":0},"children":["Integrate the Status API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Learn how to authenticate, poll the Status API, interpret operational status, and use its responses to build resilient integrations."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"overview","__idx":1},"children":["Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Status API provides an operational signal for monitored Demand API endpoints."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use it alongside your existing error handling to detect broader service degradation and adjust your integration when appropriate."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can monitor the operational status of endpoint groups or individual endpoints, depending on the level of detail your integration requires."]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"View status in the dashboard"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can also view the current operational status of monitored endpoints in the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://partnerships-status.booking.com/status"},"children":["Status dashboard"]},". The dashboard is for visual monitoring; use the Status API to retrieve status programmatically."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"before-you-begin","__idx":2},"children":["Before you begin"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To access the Status API, you need:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["✓ Send Status API requests to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["partnerships-status.booking.com"]},".",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ","✓ Include your Booking.com partner identifier in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Partner-Id"]}," request header in every request."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You do not need any activation as this service is available by default to your ID."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"authentication","__idx":3},"children":["Authentication"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Include your partner identifier in every request."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example request"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"GET /api/1.0/status HTTP/1.1\nHost: partnerships-status.booking.com\nX-Partner-Id: 125879\nAccept: application/json\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Partner-Id"]}," header is missing or invalid, the API returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401 Unauthorized"]},"."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/demand/docs/support/error-handling/about-errors"},"children":["Error handling guide"]}," for more details."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"retrieve-the-current-status","__idx":4},"children":["Retrieve the current status"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Call the following endpoint periodically to retrieve the latest operational status of monitored Demand API endpoint groups and their individual endpoints:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/1.0/status"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response contains one or more endpoint groups."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each group contains:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The operational status of the group."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The operational status of each monitored endpoint within the group."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The time when the status was last evaluated."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Additional information about an issue when the status is not ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["up"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example response"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": [\n%}    {\n      \"group\": \"Reservations\",\n      \"status\": \"major_outage\",\n      \"updated_at\": \"2026-04-20T14:32:00Z\",\n      \"since\": \"2026-04-20T14:30:15Z\",\n      \"reason\": \"Issue reason\",\n      \"endpoints\": [\n        {\n          \"endpoint\": \"/orders/create\",\n          \"status\": \"major_outage\",\n          \"updated_at\": \"2026-04-20T14:32:00Z\",\n          \"since\": \"2026-04-20T14:30:15Z\",\n          \"reason\": \"Issue reason\"\n        },\n        {\n          \"endpoint\": \"/orders/preview\",\n          \"status\": \"up\",\n          \"updated_at\": \"2026-04-20T14:32:00Z\"\n        }\n      ]\n    }\n  ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"understand-the-response","__idx":5},"children":["Understand the response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each endpoint group includes the following information."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"style":{"width":"80px"}},"children":["Field"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"style":{"width":"250px"}},"children":["Description"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["group"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the endpoint group."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Current operational status of the group."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["updated_at"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["UTC timestamp when the group status was last evaluated."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["since"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Present only when the status is not ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["up"]},". Indicates when the current issue began."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reason"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Present only when the status is not ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["up"]},"."," ","Provides a human-readable explanation of the issue."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["endpoints"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["List of monitored Demand API endpoints within the group and their operational status."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each endpoint contains the same operational status information, together with its Demand API endpoint path."]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["since"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reason"]}," fields are only present when the corresponding status is not ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["up"]},". Your integration should not assume that these fields are present for an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["up"]}," status."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"understand-operational-statuses","__idx":6},"children":["Understand operational statuses"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," field indicates the current operational state of an endpoint group or individual endpoint."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Status"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"style":{"width":"100px"}},"children":["Status"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["up"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The monitored endpoint or group is operating normally."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["minor_outage"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The monitored endpoint or group is experiencing degraded service but remains partially operational."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["major_outage"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The monitored endpoint or group is experiencing significant service disruption."]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Operational status represents the overall state detected by the Status API. It does not guarantee whether an individual Demand API request will succeed or fail."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"choose-group-or-endpoint-monitoring","__idx":7},"children":["Choose group or endpoint monitoring"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can monitor the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," field at either group or endpoint level, depending on your application's requirements."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"monitor-groups-when","__idx":8},"children":["Monitor groups when"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Your application depends on an entire functional area."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You only need to determine whether a broader set of operations is affected."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You want a simpler monitoring implementation."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If your integration monitors groups, use the group-level ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," as the operational signal for that group."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"monitor-individual-endpoints-when","__idx":9},"children":["Monitor individual endpoints when"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Different endpoints power different user journeys."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You want to adjust only functionality affected by a specific endpoint."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You need more granular operational decisions."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If your integration monitors individual endpoints, evaluate the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," of the relevant endpoint instead."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"poll-the-status-api","__idx":10},"children":["Poll the Status API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Status API is designed to be polled periodically. Status information is cached server-side for approximately 10 seconds."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Booking.com recommends polling the Status API ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["every 30 to 60 seconds"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Because status information is stored, polling more frequently is unlikely to provide newer information and increases request volume."]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/genius-bulb.3e13976eeeabd0526f1d76bfb7de5967932211a5ef4afe526a3b0a71a7b02fb0.5e2a7131.png","alt":"genius-bulb"},"children":[]}," Store the latest successful response between polls and define how your integration handles stale status information if subsequent Status API requests fail."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"rate-limiting","__idx":11},"children":["Rate limiting"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Status API has its own rate limit, independent of the Demand API."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Current limit:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["60 requests per 60 seconds per partner"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you exceed the limit, the API returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["429 Too Many Requests"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Your integration should handle 429 responses appropriately and avoid immediately repeating requests that could continue to exceed the limit."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/demand/docs/support/error-handling/about-errors"},"children":["Error handling guide"]}," for details."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"recommended-integration-behaviour","__idx":12},"children":["Recommended integration behaviour"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the Status API as a signal to adjust your application's behaviour according to your requirements."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Status"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"style":{"width":"100px"}},"children":["Status"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Recommended action"},"children":["Recommended action"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["up"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Continue normal operation."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["minor_outage"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Consider using retries with exponential backoff, adjusting timeouts, or displaying degraded-service messaging where appropriate."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["major_outage"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Consider temporarily disabling affected functionality, switching to an alternative workflow, or informing users that the affected service is temporarily unavailable."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These actions are recommendations rather than requirements. Choose the behaviour that is appropriate for your integration and user journey."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Status API should complement—not replace—your existing error handling and retry logic. Continue to handle individual Demand API errors, timeouts, and network failures as normal."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"handle-status-api-failures","__idx":13},"children":["Handle Status API failures"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Your integration should remain resilient if the Status API itself is temporarily unavailable or a status request fails."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A failure to retrieve status information does not indicate that a monitored Demand API endpoint is unavailable."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If a Status API request fails:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Continue to handle Demand API requests and responses using your existing error-handling logic."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Do not interpret a Status API error or timeout as a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["minor_outage"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["major_outage"]}," for the Demand API."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Consider retaining the latest successfully retrieved status for operational context."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Take the age of cached status information into account before using it to make operational decisions."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Retry Status API requests according to your normal retry and backoff strategy."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This separation helps prevent an issue affecting status monitoring from unnecessarily disrupting your Demand API integration."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"best-practices","__idx":14},"children":["Best practices"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["✅ Poll the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," every 30–60 seconds.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ","✅ Store the latest successful response between scheduled polls.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ","✅ Use endpoint-level monitoring if only specific features depend on an individual endpoint.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ","✅ Use group-level monitoring for simpler operational checks.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ","✅ Continue implementing retries and error handling for individual API requests.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ","✅ Do not use the Status API as a source of historical monitoring or uptime reporting.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":15},"children":["Next steps"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Continue with the API reference for the complete endpoint specification, request format, and response schema."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/demand/docs/additional-services/status-api/status-api-open-specs"},"children":["API reference Status API"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Review the endpoint schema, response fields, status values, and error codes before implementing your integration."]}]}]}]},"headings":[{"value":"Integrate the Status API","id":"integrate-the-status-api","depth":1},{"value":"Overview","id":"overview","depth":2},{"value":"Before you begin","id":"before-you-begin","depth":2},{"value":"Authentication","id":"authentication","depth":2},{"value":"Retrieve the current status","id":"retrieve-the-current-status","depth":2},{"value":"Understand the response","id":"understand-the-response","depth":3},{"value":"Understand operational statuses","id":"understand-operational-statuses","depth":3},{"value":"Choose group or endpoint monitoring","id":"choose-group-or-endpoint-monitoring","depth":2},{"value":"Monitor groups when","id":"monitor-groups-when","depth":3},{"value":"Monitor individual endpoints when","id":"monitor-individual-endpoints-when","depth":3},{"value":"Poll the Status API","id":"poll-the-status-api","depth":2},{"value":"Rate limiting","id":"rate-limiting","depth":3},{"value":"Recommended integration behaviour","id":"recommended-integration-behaviour","depth":2},{"value":"Handle Status API failures","id":"handle-status-api-failures","depth":2},{"value":"Best practices","id":"best-practices","depth":2},{"value":"Next steps","id":"next-steps","depth":2}],"frontmatter":{"seo":{"title":"Integrate the Status API"}},"lastModified":"2026-10-23T17:00:10.489Z","pagePropGetterError":{"message":"","name":""}},"slug":"/demand/docs/additional-services/status-api/integration-guide","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}