Search exclusions
search_exclusionsRead-onlyIdempotent
Filter active exclusion records by agency, program, classification, geography and dates. Limit is a maximum; large records can produce a smaller page with page_size_limited true. Continue with next_cursor and unchanged filters and limit. Preserve generation and read coverage.freshness for source age and warnings; results are dated evidence, not clearance.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Name, identifier, or other text to find in active exclusion records. | |
| limit | No | Maximum records to return, from 1 to 50. Large records may produce a smaller page; continue with next_cursor and unchanged filters and limit. | |
| state | No | US state name or postal code in the exclusion record. | |
| agency | No | Excluding agency name or code. | |
| cursor | No | Opaque next_cursor from a previous search response. | |
| country | No | Country name or code in the exclusion record. | |
| program | No | Exclusion program name or code. | |
| generation | No | Retained snapshot UUID; omit for the current snapshot. | |
| effective_to | No | Include records effective on or before this ISO date. | |
| classification | No | Official SAM exclusion classification code or label. | |
| effective_from | No | Include records effective on or after this ISO date. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| items | Yes | ||
| coverage | Yes | Dated source coverage, or an unavailable status. | |
| generation | Yes | ||
| next_cursor | No | ||
| page_size_limited | Yes | Whole records were deferred to next_cursor to fit the response budget. Continue with the same filters and requested limit. |