{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/open-data:slideroom/applicant-get-attributes-v2":{"get":{"operationId":"open_data_slideroom_applicant_get_attributes_v2","summary":"Gets the custom attributes for an applicant.","description":"GET /api/v2/applicant/attributes","tags":["open-data"],"parameters":[{"name":"email","in":"query","required":true,"description":"The email address of the applicant.","schema":{"type":"string","description":"The email address of the applicant."}},{"name":"pool","in":"query","required":false,"schema":{"type":"string","enum":["Standard","CommonAppSDS"]}},{"name":"commonAppYear","in":"query","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:slideroom/applicant-post-attributes-v2":{"post":{"operationId":"open_data_slideroom_applicant_post_attributes_v2","summary":"Updates the custom attributes for an applicant.","description":"POST /api/v2/applicant/attributes","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["email","body"],"properties":{"email":{"type":"string","description":"The email address of the applicant."},"pool":{"type":"string","enum":["Standard","CommonAppSDS"]},"commonAppYear":{"type":"integer"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:slideroom/applicant-delete-attributes-v2":{"post":{"operationId":"open_data_slideroom_applicant_delete_attributes_v2","summary":"Deletes a custom attribute for an applicant.","description":"DELETE /api/v2/applicant/attributes","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["email","name"],"properties":{"email":{"type":"string","description":"The email address of the applicant."},"name":{"type":"string","description":"The name of the attribute to be deleted."},"pool":{"type":"string","enum":["Standard","CommonAppSDS"]},"commonAppYear":{"type":"integer"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:slideroom/applicant-get-attribute-names-v2":{"get":{"operationId":"open_data_slideroom_applicant_get_attribute_names_v2","summary":"Gets the custom applicant attributes used by the organization.","description":"GET /api/v2/applicant/attributes/names","tags":["open-data"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:slideroom/application-get-attribute-names-v2":{"get":{"operationId":"open_data_slideroom_application_get_attribute_names_v2","summary":"Gets the custom application attributes used by the organization.","description":"GET /api/v2/application/attributes/names","tags":["open-data"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:slideroom/application-request-export-v2":{"post":{"operationId":"open_data_slideroom_application_request_export_v2","summary":"Requests the generation of application export files (tabular, pdf, zip).","description":"POST /api/v2/application/request-export","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"format":{"type":"string","enum":["csv","tsv","txt","tab","xlsx","pdf","zip","json"]},"roundType":{"type":"string","enum":["Assigned","Current","Named","All"]},"roundName":{"type":"string"},"tab.export":{"type":"string"},"pdf.includeForms":{"type":"boolean"},"pdf.includeReferences":{"type":"boolean"},"pdf.includeMedia":{"type":"boolean"},"pdf.includeApplicantAttachments":{"type":"boolean"},"pdf.includeOrganizationAttachments":{"type":"boolean"},"pdf.includeRatings":{"type":"boolean"},"pdf.includeFullPageMedia":{"type":"boolean"},"pdf.includeHighlights":{"type":"boolean"},"pdf.includeComments":{"type":"boolean"},"pdf.includeCommonApp":{"type":"boolean"},"zip.originalMedia":{"type":"boolean"},"zip.includeForms":{"type":"boolean"},"zip.includeReferences":{"type":"boolean"},"zip.includeMedia":{"type":"boolean"},"zip.includeApplicantAttachments":{"type":"boolean"},"zip.includeOrganizationAttachments":{"type":"boolean"},"zip.includeRatings":{"type":"boolean"},"zip.includeComments":{"type":"boolean"},"zip.includeCommonApp":{"type":"boolean"},"delivery.account":{"type":"string"},"delivery.folder":{"type":"string"},"since":{"type":"integer"},"pool":{"type":"string","enum":["All","Current","Archived","CommonAppSDS"]},"status":{"type":"string","enum":["All","InProgress","Submitted"]},"searchName":{"type":"string"},"email":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:slideroom/application-get-attributes-v2":{"get":{"operationId":"open_data_slideroom_application_get_attributes_v2","summary":"Gets the custom attributes for an application.","description":"GET /api/v2/application/{applicationId}/attributes","tags":["open-data"],"parameters":[{"name":"applicationId","in":"query","required":true,"description":"The ID of the application.","schema":{"type":"string","description":"The ID of the application."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:slideroom/application-post-attributes-v2":{"post":{"operationId":"open_data_slideroom_application_post_attributes_v2","summary":"Updates the custom attributes for an application. API Import is available in the Advanced Plan.","description":"POST /api/v2/application/{applicationId}/attributes","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["applicationId","body"],"properties":{"applicationId":{"type":"string","description":"The ID of the application."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:slideroom/application-delete-attributes-v2":{"post":{"operationId":"open_data_slideroom_application_delete_attributes_v2","summary":"Deletes a custom attribute for an application.","description":"DELETE /api/v2/application/{applicationId}/attributes","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["applicationId","name"],"properties":{"applicationId":{"type":"string","description":"The ID of the application."},"name":{"type":"string","description":"The name of the attribute to be deleted."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:slideroom/application-request-export-by-application-id-v2":{"post":{"operationId":"open_data_slideroom_application_request_export_by_application_id_v2","summary":"Requests the generation of a single application export file (tabular, pdf, zip).","description":"POST /api/v2/application/{applicationId}/request-export","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["applicationId"],"properties":{"applicationId":{"type":"string","description":"The id of the application to export"},"format":{"type":"string","enum":["csv","tsv","txt","tab","xlsx","pdf","zip","json"]},"roundType":{"type":"string","enum":["Assigned","Current","Named","All"]},"roundName":{"type":"string"},"tab.export":{"type":"string"},"pdf.includeForms":{"type":"boolean"},"pdf.includeReferences":{"type":"boolean"},"pdf.includeMedia":{"type":"boolean"},"pdf.includeApplicantAttachments":{"type":"boolean"},"pdf.includeOrganizationAttachments":{"type":"boolean"},"pdf.includeRatings":{"type":"boolean"},"pdf.includeFullPageMedia":{"type":"boolean"},"pdf.includeHighlights":{"type":"boolean"},"pdf.includeComments":{"type":"boolean"},"pdf.includeCommonApp":{"type":"boolean"},"zip.originalMedia":{"type":"boolean"},"zip.includeForms":{"type":"boolean"},"zip.includeReferences":{"type":"boolean"},"zip.includeMedia":{"type":"boolean"},"zip.includeApplicantAttachments":{"type":"boolean"},"zip.includeOrganizationAttachments":{"type":"boolean"},"zip.includeRatings":{"type":"boolean"},"zip.includeComments":{"type":"boolean"},"zip.includeCommonApp":{"type":"boolean"},"delivery.account":{"type":"string"},"delivery.folder":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"live"}},"/v1/open-data:slideroom/export-get-v2":{"get":{"operationId":"open_data_slideroom_export_get_v2","summary":"Gets the status/result of a requested export.","description":"GET /api/v2/export/{token}","tags":["open-data"],"parameters":[{"name":"token","in":"query","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}