> ## Documentation Index > Fetch the complete documentation index at: https://docs.affinda.com/llms.txt > Use this file to discover all available pages before exploring further. ## Submitting Feedback If you encounter incorrect, outdated, or confusing documentation on this page, submit feedback: POST https://docs.affinda.com/feedback ```json { "path": "/api-reference/resume-redactor/get-list-of-all-redacted-resumes", "feedback": "Description of the issue" } ``` Only submit feedback when you have something specific and actionable to report. # Get list of all redacted resumes > Returns all the redacted resume information for that resume ## OpenAPI ````yaml https://api.affinda.com/static/v2/api_spec.yaml get /v2/redacted_resumes openapi: 3.0.3 info: description: >- # Introduction Affinda uses the latest advancements in AI technology to rapidly process documents with better-than-human accuracy. This guide covers how to: * Extract structured data from a range of document types * Integrate our solutions into your platform * Manage users *Note: This API spec is for the deprecated v2 of the API, the v3 documentation [can be found here](https://api.affinda.com/docs/v3)* > **Important: Use the correct API URL for your region.** Affinda is hosted across multiple instances. Make sure you are sending requests to the correct URL for your account: > | Instance | API Base URL | > |----------|-------------| > | **AUS / Global** | `https://api.affinda.com` | > | **US** | `https://api.us1.affinda.com` | > | **EU** | `https://api.eu1.affinda.com` | > > You can determine your instance from the URL you use to access the Affinda web app (e.g. `app.us1.affinda.com` means you are on the US instance). When using the "Try it" feature, select the matching region from the server dropdown. # Getting Started * Obtain an API key by [signing up for a free-trial](https://app.affinda.com/auth/register) * (Recommended) Download and install one of our client libraries: * [Python](https://github.com/affinda/affinda-python) : `pip install affinda` * [Javascript](https://github.com/affinda/affinda-typescript) : `npm install @affinda/affinda` * [.NET](https://github.com/affinda/affinda-dotnet): `dotnet add package Affinda.API` * [Java](https://github.com/affinda/affinda-java) - [maven repository](https://mvnrepository.com/artifact/com.affinda.api/affinda-api-client) * Without a client library, API requests via HTTP according to the API spec in this documentation version: v2 title: Affinda API contact: email: contact@affinda.com license: name: MIT url: https://raw.githubusercontent.com/affinda/affinda-api-spec/master/LICENSE x-logo: url: https://api.affinda.com/static/documentation/affinda_logo.png backgroundColor: '#FFFFFF' altText: Affinda logo servers: - url: https://{region}.affinda.com description: >- Select the correct server for your instance: api (AUS/Global), api.us1 (US), or api.eu1 (EU). variables: region: default: api description: >- The instance region. Use 'api' for AUS/Global, 'api.us1' for US, or 'api.eu1' for EU. You can find your region in the Affinda web app URL. enum: - api - api.eu1 - api.us1 x-ms-parameter-location: client security: - ApiKeyAuth: [] tags: - name: Invoice Extractor description: >- Operations to perform on parsed invoices via the Affinda Invoice Extractor API or a client library - name: Resume Parser description: >- Operations to perform on parsed resumes via the Affinda Resume Parser API or a client library - name: Job Description Parser description: >- Operations to perform on job descriptions via the Affinda Job Description API or a client library - name: Search & Match - Indexing description: > Operations to create and manage indexes and to add new documents to these indexes via the Affinda Resume Parser API or a client library. Resumes and job descriptions must be explicitly added to an index, which then makes them searchable (see Search & Match – Searching). - name: Search & Match - Searching description: >- Operations to search through an index of documents via the Affinda Resume Parser API or a client library. - name: Search & Match - Embedding description: Operations to fetch and configure the embeddable search tool. - name: Resume Search description: > Operations to search parsed resumes via the Affinda Resume Parser API or a client library. Resumes must be explicitly added to an index, which then makes them searchable with the below endpoint. - name: Resume Redactor description: >- Operations to perform on redacted resumes via the Affinda Resume Parser API or a client library - name: Users description: > Operations to manage users that are part of an account. For example, you may want to implement different settings for different users in your platform. You can use these endpoints to generate new user accounts, and the usage for these accounts will be deducted from your master account. If you would like these user accounts to be able to login at https://app.affinda.com/, they will need to go to https://app.affinda.com/ and reset their password using the email used to create their account. - name: Documents API description: Placeholder - name: Webhook API description: Manage webhook integrations with your apps. paths: /v2/redacted_resumes: get: tags: - Resume Redactor summary: Get list of all redacted resumes description: Returns all the redacted resume information for that resume operationId: getAllRedactedResumes parameters: - $ref: '#/components/parameters/offsetParam' - $ref: '#/components/parameters/limitParam' - in: query name: custom_identifier schema: type: string description: Filter for documents with this custom identifier. responses: '200': description: All redacted resumes for user content: application/json: schema: type: object required: - results - count allOf: - $ref: '#/components/schemas/PaginatedResponse' - type: object properties: results: type: array items: $ref: '#/components/schemas/Meta' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '403': $ref: '#/components/responses/403Error' default: $ref: '#/components/responses/DefaultError' components: parameters: offsetParam: in: query name: offset required: false schema: type: integer minimum: 0 example: 0 description: >- The number of documents to skip before starting to collect the result set. x-ms-parameter-location: method limitParam: in: query name: limit required: false schema: type: integer minimum: 1 maximum: 100 example: 20 description: The numbers of results to return. x-ms-parameter-location: method schemas: PaginatedResponse: type: object required: - count properties: count: type: integer example: 10 minimum: 0 description: Number of items in results. next: type: string nullable: true description: URL to request next page of results. previous: type: string nullable: true description: URL to request previous page of results. Meta: type: object properties: identifier: type: string description: Unique identifier for the document customIdentifier: type: string nullable: true description: >- Optional identifier for the document that you can set to track the document in the Affinda system. Is not required to be unique. example: 46ab8b02-0e5b-420c-877c-8b678d46a834 fileName: $ref: '#/components/schemas/FileName' ready: type: boolean nullable: false example: true description: >- If true, the document has finished processing. Particularly useful if an endpoint request specified wait=False, when polling use this variable to determine when to stop polling readyDt: type: string format: date-time example: '2020-12-10T01:43:32.276724Z' nullable: true description: The datetime when the document was ready failed: type: boolean nullable: false example: false description: >- If true, some exception was raised during processing. Check the 'error' field of the main return object. expiryTime: $ref: '#/components/schemas/ExpiryTime' language: type: string nullable: true example: en description: The document's language. pdf: type: string nullable: true example: >- https://affinda-api.s3.amazonaws.com/media/documents/Document.pdf?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062 description: >- The URL to the document's pdf (if the uploaded document is not already pdf, it's converted to pdf as part of the parsing process). parentDocument: type: object nullable: true description: >- If this document is part of a splitted document, this attribute points to the original document that this document is splitted from. properties: identifier: $ref: '#/components/schemas/identifier' childDocuments: type: array description: >- If this document has been splitted into a number of child documents, this attribute points to those child documents. items: type: object properties: identifier: $ref: '#/components/schemas/identifier' pages: type: array items: $ref: '#/components/schemas/PageMeta' description: The document's pages. isVerified: type: boolean nullable: false example: false description: >- This is true if the 'confirm' button has been clicked in the Affinda validation tool reviewUrl: type: string nullable: true example: https://app.affinda.com/review/XJ5kK123?signature=12345 description: >- Signed URL (valid for 60 minutes) to access the validation tool. Not applicable for documents types such a resumes. ocrConfidence: type: number nullable: true example: 0.97 description: >- The overall confidence in the conversion of image to text. (only applicable for images or PDF documents without a text layer) createdDt: type: string format: date-time documentType: type: string example: resume regionBias: $ref: '#/components/schemas/RegionBias' isOcrd: type: boolean FileName: type: string nullable: true description: Optional filename of the file example: Document.pdf ExpiryTime: type: string nullable: true format: date-time description: >- The date/time in ISO-8601 format when the document will be automatically deleted. Defaults to no expiry. identifier: type: string description: Unique identifier for the document PageMeta: type: object required: - id - pageIndex - image - width - height - rotation properties: id: type: integer minimum: 1 pageIndex: type: integer example: 0 minimum: 0 description: Page number within the document, starts from 0. image: type: string nullable: true example: >- https://affinda-api.s3.amazonaws.com/media/pages/Page.png?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062 description: The URL to the image of the page. imageTranslated: type: string nullable: true example: >- https://affinda-api.s3.amazonaws.com/media/pages/PageTranslated.png?AWSAccessKeyId=KEY&Signature=SIG&Expires=1663302062 description: The URL to the translated image of the page. height: type: number example: 700 description: Height of the page's image in px. width: type: number example: 500 description: Width of the page's image in px. rotation: type: integer example: 90 minimum: -360 maximum: 360 description: >- The degree of rotation applied to the page. Greater than 0 indicates clockwise rotation. Less than 0 indicates counter-clockwise rotation. RegionBias: type: object nullable: true properties: country: type: string nullable: true description: >- A single alpha-2 country code (e.g. AU) used by google geocoding service countries: type: array items: type: string nullable: true description: A list of alpha-2 country codes used by Pelias squareCoordinates: type: array items: type: number nullable: true description: >- A list of coordinates used by Pelias in the shape of [min_lon, min_lat, max_lon, max_lat] strict: type: boolean description: > If true, the location must be within the region, as opposed to prefering locations within the region. Default to false. example: true RequestError: type: object additionalProperties: false required: - type - errors properties: type: type: string example: validation_error errors: type: array items: type: object required: - attr - code - detail properties: attr: type: string nullable: true example: non_field_errors code: type: string example: unique detail: type: string example: This index name has already been used responses: 400Error: description: >- Bad request. If it is a validation error will contain a list of each invalid field content: application/json: schema: $ref: '#/components/schemas/RequestError' x-ms-error-response: true 401Error: description: Authorisation error content: application/json: schema: $ref: '#/components/schemas/RequestError' x-ms-error-response: true 403Error: description: Forbidden error content: application/json: schema: $ref: '#/components/schemas/RequestError' x-ms-error-response: true DefaultError: description: UnexpectedError content: application/json: schema: $ref: '#/components/schemas/RequestError' x-ms-error-response: true securitySchemes: ApiKeyAuth: type: http scheme: bearer description: >- Basic authentication using an API key, e.g. `{Authorization: Bearer 75z0bb4fbdf97b7e4111ff6c0015471094155f91}`. You can find your API key within the Settings page of the [Affinda web app](https://app.affinda.com/). You can obtain an API key by [signing up for a free trial](https://app.affinda.com/auth/register). ````