{"command":{"effect":"read","timeoutSeconds":30,"inputSchema":{"type":"object","description":"      The `list all companies` functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset.\n\n- Each app can only have 1 scroll open at a time. Starting a second one returns a `400` error with code `scroll_exists`.\n- If the scroll isn't used for 1 minute, it expires and calls with that scroll param return a `404` error with code `not_found`.\n- If the end of the scroll is reached, `data` will be empty and the scroll parameter will expire.\n\nThe response always has `pages` and `total_count` set to `null`. Use `scroll_param` to fetch the next page.\n\n{% admonition type=\"info\" name=\"Scroll Parameter\" %}\n  You can get the first page of companies by simply sending a GET request to the scroll endpoint.\n  For subsequent requests you will need to use the scroll parameter from the response.\n{% /admonition %}\n{% admonition type=\"danger\" name=\"Scroll network timeouts\" %}\n  Since scroll is often used on large datasets network errors such as timeouts can be encountered. When this occurs you will see a HTTP 500 error with the following message:\n  \"Request failed due to an internal network error. Please restart the scroll operation.\"\n  If this happens, you will need to restart your scroll query: It is not possible to continue from a specific point when using scroll.\n{% /admonition %}\n\nRequires the `read_users_companies` OAuth scope.\n","properties":{"headers":{"type":"object","properties":{"Intercom-Version":{"$ref":"#/definitions/intercom_version","enum":["2.17"]}},"required":[],"additionalProperties":false},"query":{"type":"object","properties":{"scroll_param":{"type":"string","examples":["69352cd2-ab5b-42ac-b004-a13d4e55e9b0"],"description":"The `scroll_param` from the previous response. Omit it to start a new scroll."}},"required":[],"additionalProperties":false}},"required":[],"additionalProperties":false,"definitions":{"intercom_version":{"description":"Intercom API version.</br>If you omit the header, the API uses the version set in your app package, and 1.0 if none is set.","type":"string","enum":["1.0","1.1","1.2","1.3","1.4","2.0","2.1","2.2","2.3","2.4","2.5","2.6","2.7","2.8","2.9","2.10","2.11","2.12","2.13","2.14","2.15","2.16","2.17"],"examples":["2.17"]}}},"name":"Scroll over all companies","id":"intercom.scrolloverallcompanies","example":{},"maxRequests":1,"summary":false}}