List envelope
Response structure for an Intelligence REST collection, placing items in a data array beside pagination, attribution, and request metadata. The pagination object reports whether more items remain, supplies forward and backward cursors, and may give a total count or null.
In plain language
Read the items, then follow the returned cursor when another page exists.
In a sentence
- The list envelope included a next cursor after the first page of roles.
- We kept the list envelope's attribution when combining pages for a report.
Usage note
A null total count means the server did not compute it for that request. It does not mean the collection is empty.
See also
- Resource envelope
Response structure for one Intelligence REST resource, with the result in data and separate attribution and request objects.
- Cursor pagination
Method of traversing Intelligence list results by passing an opaque cursor from a prior response through starting_after or ending_before.
- Attribution block
Response object beside an Intelligence REST result that names Orbyt Intelligence as the source and gives its methodology link and version.
Cite this term.
CC BY 4.0, attribution required.
Orbyt Labs, List envelope (Developer Glossary), Nov 6, 2026. https://
Orbyt Labs Glossaries (Nov 14, 2026), https://
Last updated .