/samgov/exclusions

POST /api/samgov/exclusions

Price: 1 credit

Get a federal exclusion (debarment / ineligible) record by id

How to use it

Get full details of a single U.S. federal exclusion record (a party debarred, suspended, or otherwise ineligible to receive federal contracts, grants, or benefits) by its exclusion id. Returns the subject name (or first/last name for individuals), classification, exclusion type and program, excluding agency, status, activation and termination dates, UEI, CAGE code, address, the full additional-comments text, and any cross-referenced exclusion records.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• exclusion string required — Exclusion record id (UUID) (examples: "268b6a87-711e-4198-9a9e-063c3eef8c04"; minLength: 1)

Response

• @type string (default: "SamgovExclusion")
• id string required
• name string nullable
• classification string nullable
• exclusion_type string nullable
• exclusion_program string nullable
• excluding_agency string nullable
• excluding_agency_code string nullable
• ct_code string nullable
• status string nullable
• activated_at string nullable
• terminated_at string nullable
• uei_sam string nullable
• cage_code string nullable
• address object nullable
  • @type string (default: "SamgovExclusionAddress")
  • street_address string nullable
  • street_address2 string nullable
  • city string nullable
  • state string nullable
  • zip string nullable
  • country string nullable
• is_active boolean nullable
• first_name string nullable
• middle_name string nullable
• last_name string nullable
• suffix string nullable
• npi string nullable
• description string nullable
• created_at string nullable
• updated_at string nullable
• cross_references array (default: [])
  • @type string (default: "SamgovExclusionCrossReference")
  • id string nullable
  • name string nullable
  • cross_reference_type string nullable
  • exclusion_type string nullable
  • excluding_agency string nullable
  • activated_at string nullable
  • terminated_at string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Exclusion not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.