---
title: "Get list of all extractors"
method: GET
path: "/v3/extractors"
tags: ["Document API - Extractor"]
deprecated: true
---

# Get list of all extractors

`GET /v3/extractors`

> **Deprecated.**

Returns your custom extractors as well as Affinda's off-the-shelf extractors.

## Query parameters

- `organization` string, required — Uniquely identify an organization.
- `include_public_extractors` boolean
- `name` string
- `validatable` boolean

## Response `200`

All matching extractors.

- Extractor[]
  - `identifier` string, required — Uniquely identify an extractor.
  - `name` string, required
  - `namePlural` string, required
  - `baseExtractor` object, nullable
    - `identifier` string, required — Uniquely identify an extractor.
    - `name` string, required
    - `namePlural` string, required
    - `validatable` boolean, required
    - `isCustom` boolean
    - `createdDt` string, date-time
  - `organization` Organization
    - `identifier` string, required — Uniquely identify an organization.
    - `name` string, required
    - `userRole` 'admin' | 'member', required
    - `avatar` string, nullable, required — URL of the organization's avatar.
    - `resthookSignatureKey` string, nullable, required — Used to sign webhook payloads so you can verify their integrity.
    - `isTrial` boolean, required
    - `validationToolConfig` object, nullable, required — Configuration of the embeddable validation tool.
      - `theme` ThemeConfig
        - `palette` object
          - `mode` 'light' | 'dark'
          - `background` union
            - string
            - object
              - …
          - `text` object
            - `primary` string
            - `secondary` string
            - `disabled` string
          - `divider` string
          - `primary` PaletteColorOptions
            - `main` string, required
            - `light` string
            - `dark` string
            - `contrastText` string
          - `secondary` PaletteColorOptions
            - `main` string, required
            - `light` string
            - `dark` string
            - `contrastText` string
          - `success` PaletteColorOptions
            - `main` string, required
            - `light` string
            - `dark` string
            - `contrastText` string
          - `annotation` PaletteColorOptions
            - `main` string, required
            - `light` string
            - `dark` string
            - `contrastText` string
          - `error` PaletteColorOptions
            - `main` string, required
            - `light` string
            - `dark` string
            - `contrastText` string
          - `info` PaletteColorOptions
            - `main` string, required
            - `light` string
            - `dark` string
            - `contrastText` string
          - `warning` PaletteColorOptions
            - `main` string, required
            - `light` string
            - `dark` string
            - `contrastText` string
        - `typography` object
          - `fontFamily` string
          - `fontSize` union
            - string
            - number
          - `fontWeightRegular` string
          - `fontWeightMedium` string
          - `fontWeightBold` string
        - `borderRadius` number
        - `fontUrl` string
      - `hideActions` boolean — Hide the confirm document button and other actions.
      - `hideCollection` boolean — Hide the collection selector.
      - `hideEditPages` boolean — Hide the edit pages button.
      - `hideExport` boolean — Hide the export menu.
      - `hideFilename` boolean — Hide the filename input.
      - `hideShowRawValues` boolean — Hide the toggle for showing raw annotation values.
      - `hideReject` boolean — Hide the reject document button.
      - `hideReparse` boolean — Hide the reparse button.
      - `hideRunOcr` boolean — Hide the run OCR button.
      - `hideTags` boolean — Hide the tags editor.
      - `hideWarnings` boolean — Hide the warnings panel.
      - `restrictDocumentSplitting` boolean — Disable the page editor after a document has been split once.
      - `disableCurrencyFormatting` boolean — Disable currency formatting of decimals values.
      - `disableEditDocumentMetadata` boolean — Disable editing document metadata. Makes the collection selector, filename input and tags editor read only.
      - `disableManualAnnotationEditing` boolean — Disable manual editing of annotation values via the validation popover.
      - `hideDocumentStatus` boolean — Hide the document status indicator in the toolbar.
    - `showCustomFieldCreation` boolean, required — Whether to show the custom field creation in the UI.
    - `allowDataSourceRecordCreation` boolean, required — Allow reviewers to create missing records from the data source selector. Keep disabled when data sources are managed by external system syncs.
  - `category` string, nullable
  - `validatable` boolean, required
  - `isCustom` boolean
  - `fieldGroups` FieldGroup[], nullable
    - `label` string, required
    - `fields` FieldDeprecated[], required
      - `label` string, required
      - `slug` string, nullable
      - `fieldType` 'text' | 'integer' | 'float' | 'decimal' | 'date' | 'datetime' | 'daterange' | 'boolean' | 'enum' | 'location' | 'phonenumber' | 'json' | 'table' | 'expectedremuneration' | 'jobtitle' | 'language' | 'skill' | 'yearsexperience' | 'group' | 'table_deprecated' | 'url' | 'image' | 'docclf', required — The different data types of annotations
      - `dataSource` string, nullable — Data source mapping identifier
      - `mapping` string, nullable — Defines how the data point is mapped to the data source
      - `dataPoint` string, required
      - `mandatory` boolean
      - `disabled` boolean
      - `autoValidationThreshold` number, nullable
      - `showDropdown` boolean
      - `displayRawText` boolean
      - `dropNull` boolean — If True, any dropdown annotations that fail to parse to a value will be discarded
      - `displayEnumValue` boolean
      - `fields` FieldDeprecated[]
  - `createdDt` string, date-time
  - `lastTrainedDt` string, date-time, nullable

## Other responses

- `400` — Bad request. If it is a validation error will contain a list of each invalid field
- `401` — Authorisation error
- `default` — UnexpectedError

---

[API](https://skmtc.net/affinda/apis/affinda-api-2.md) · [All operations](https://skmtc.net/affinda/apis/affinda-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/affinda/affinda-api-2/versions/6772e50cb58e/schema)