openapi: 3.0.1 info: title: Exclusions Rest API description: These RESTFUL endpoints are to retrieve exclusion information via Request parameters in the paginated manner contact: name: GSA url: www.sam.gov email: reply@gsa.gov license: name: GSA version: "1.0" servers: - url: //api.sam.gov/ tags: - name: exclusions-api-controller-v-4 description: Exclusions Api Controller V 4 - name: file-download-controller description: File Download Controller paths: /entity-information/v4/download-exclusions: get: tags: - exclusions-api-controller-v-4 summary: ' download V4 exclusion extract file' operationId: getFileFromS3UsingGET requestBody: description: token to download specific file content: '*/*': schema: type: string required: false responses: 200: description: Successfully downloaded file content: application/hal+json: 401: description: You are not authorized to view the resource content: {} 403: description: Accessing the resource you were trying to reach is forbidden content: {} 404: description: The resource you were trying to reach is not found content: {} deprecated: false x-codegen-request-body-name: token /entity-information/v4/exclusions: get: tags: - exclusions-api-controller-v-4 summary: ' get Exclusions Details' operationId: getExclusionsDataUsingGET_2 parameters: - name: activationDate in: query description: A single Date or Date range in the format MM/DD/YYYY schema: type: string - name: activationDateFrom in: query schema: type: string - name: activationDateTo in: query schema: type: string - name: addressLine1 in: query description: A String (1234 test Dr) schema: type: string - name: addressLine2 in: query description: A String (1234 test Dr) schema: type: string - name: cageCode in: query description: A String (0Y5L9, null) schema: type: string - name: city in: query schema: type: string - name: cityState in: query schema: type: string - name: cityStateZipCongFlag in: query schema: type: boolean - name: classification in: query description: A String (Individual, Firm, Vessel, Special Entity Designation, null) schema: type: string - name: country in: query description: A String (USA, CAN, ARE, null) schema: type: string - name: createDateFrom in: query schema: type: string - name: createDateTo in: query schema: type: string - name: creationDate in: query description: A single Date or Date range in the format MM/DD/YYYY schema: type: string - name: ctCode in: query description: A String (A, ZZ, XXX, 03-SDNTK-01, null) schema: type: string - name: emailId in: query description: Email ID schema: type: string - name: exactMatch in: query schema: type: boolean - name: excludedPartyName in: query schema: type: string - name: excludingAgencyCode in: query description: A String (AF, DOJ, FEMA-IOD, null) schema: type: string - name: excludingAgencyName in: query description: A String (FEDERAL, FEDERAL EMERGENCY MANAGEMENT AGENCY, null) schema: type: string - name: exclusionName in: query description: A partial text or a complete text schema: type: string - name: exclusionProgram in: query description: A String (Reciprocal, Non-Procurement, Procurement) schema: type: string - name: exclusionType in: query description: A String (Ineligible (Proceedings Pending), Ineligible (Proceedings Completed), Prohibition/Restriction, Voluntary Exclusion) schema: type: string - name: format in: query description: Parameter used to download csv or json files schema: type: string - name: includeSections in: query description: Schema Filtering Paramter schema: type: string - name: isActive in: query description: A String (Y, N) schema: type: string - name: isDisasterResponseParticipant in: query schema: type: string - name: legalBusinessName in: query schema: type: string - name: naicsCode in: query schema: type: string - name: npi in: query description: A String (1053373266, null) schema: type: string - name: organizationId in: query schema: type: string - name: page in: query description: Page number schema: type: string - name: pscCode in: query schema: type: string - name: q in: query description: Free text, All the above filters and their acceptable values can be used schema: type: string - name: qMode in: query schema: type: string - name: recordStatus in: query description: Record Status (Active, Inactive) schema: type: string - name: registrationStatus in: query schema: type: string - name: size in: query description: Record size per page schema: type: string - name: sort in: query schema: type: string - name: sortOrder in: query schema: type: string enum: - asc - desc - name: ssnOrTinOrEin in: query description: 9 digit number or null (XXXXXXXXX, null) schema: type: string - name: stateProvince in: query description: A String (NC, XX, null, 470105, YAMALO-NENETSKI OKR.) schema: type: string - name: terminationDate in: query description: A single Date or Date range in the format MM/DD/YYYY schema: type: string - name: terminationDateFrom in: query schema: type: string - name: terminationDateTo in: query schema: type: string - name: title in: query schema: type: string - name: ueiSAM in: query description: Unique Entity Identifier SAM- 12 digit value - Replacement for ueiSAM schema: type: string - name: updateDate in: query description: A single Date or Date range in the format MM/DD/YYYY schema: type: string - name: zipCode in: query description: A String (0, 41722, 21453935, 752435120, 75602-1112, null, C.P. 44890, oo957, TQ13 9SE, Zimbabwe, P.O. Box Beirut-Hamra) schema: type: string - name: fascsaOrder in: query description: This field is used to filter out FASCSA Orders. It accepts Yes or No and is case-insensitive. schema: type: string responses: 200: description: Successfully retrieved list content: application/hal+json: 401: description: You are not authorized to view the resource content: {} 403: description: Accessing the resource you were trying to reach is forbidden content: {} 404: description: The resource you were trying to reach is not found content: {} deprecated: false components: {}