--- title: "Get list of all collections" method: GET path: "/v3/collections" tags: ["Deprecated End Points"] deprecated: true --- # Get list of all collections `GET /v3/collections` > **Deprecated.** Returns your collections. ## Query parameters - `workspace` string, required — Uniquely identify a workspace. ## Response `200` All matching collections. - Collection[] - `identifier` string, required — Uniquely identify a collection. - `name` string - `workspace` object - `identifier` string — Uniquely identify a workspace. - `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 - … - `text` object - … - `divider` string - `primary` PaletteColorOptions - … - `secondary` PaletteColorOptions - … - `success` PaletteColorOptions - … - `annotation` PaletteColorOptions - … - `error` PaletteColorOptions - … - `info` PaletteColorOptions - … - `warning` PaletteColorOptions - … - `typography` object - `fontFamily` string - `fontSize` union - … - `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. - `name` string - `extractor` 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 - … - `text` object - … - `divider` string - `primary` PaletteColorOptions - … - `secondary` PaletteColorOptions - … - `success` PaletteColorOptions - … - `annotation` PaletteColorOptions - … - `error` PaletteColorOptions - … - `info` PaletteColorOptions - … - `warning` PaletteColorOptions - … - `typography` object - `fontFamily` string - `fontSize` union - … - `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 - `autoValidationThreshold` number - `enableAutoValidationThreshold` boolean - `autoValidateIfValidationRulesPass` boolean - `fields` 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[] - `fieldsLayout` FieldsLayout - `defaultCategory` FieldCategory, required - `label` string, required - `enabledFields` Field[], required - `label` string, required - `dataPoint` string, required — Data point identifier - `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 - `mandatory` boolean - `autoValidationThreshold` number, nullable — Threshold for auto validation. If null, uses the collection's autoValidationThreshold. - `enableAutoValidationThreshold` boolean, nullable — If true, the autoValidationThreshold enable auto validation from the threshold from this field if specified, else from the collection - `showDropdown` boolean - `displayEnumValue` boolean — If true, both the value and the label for the enums will appear in the dropdown in the validation tool. - `hideEnumDetail` boolean — If true, the hoverable enum value detail icon will be hidden. - `dropNull` boolean — If True, any dropdown annotations that fail to parse to a value will be discarded - `enabledChildFields` Field[] - `disabledChildFields` Field[] - `slug` string, nullable - `displayRawText` boolean — If true, then the validation tool will show the user the raw text found on the page, not the value that has been parsed to a specific type. - `fields` object[], nullable - `disabledFields` Field[], required - `label` string, required - `dataPoint` string, required — Data point identifier - `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 - `mandatory` boolean - `autoValidationThreshold` number, nullable — Threshold for auto validation. If null, uses the collection's autoValidationThreshold. - `enableAutoValidationThreshold` boolean, nullable — If true, the autoValidationThreshold enable auto validation from the threshold from this field if specified, else from the collection - `showDropdown` boolean - `displayEnumValue` boolean — If true, both the value and the label for the enums will appear in the dropdown in the validation tool. - `hideEnumDetail` boolean — If true, the hoverable enum value detail icon will be hidden. - `dropNull` boolean — If True, any dropdown annotations that fail to parse to a value will be discarded - `enabledChildFields` Field[] - `disabledChildFields` Field[] - `slug` string, nullable - `displayRawText` boolean — If true, then the validation tool will show the user the raw text found on the page, not the value that has been parsed to a specific type. - `fields` object[], nullable - `categories` FieldCategory[], required - `label` string, required - `enabledFields` Field[], required - `label` string, required - `dataPoint` string, required — Data point identifier - `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 - `mandatory` boolean - `autoValidationThreshold` number, nullable — Threshold for auto validation. If null, uses the collection's autoValidationThreshold. - `enableAutoValidationThreshold` boolean, nullable — If true, the autoValidationThreshold enable auto validation from the threshold from this field if specified, else from the collection - `showDropdown` boolean - `displayEnumValue` boolean — If true, both the value and the label for the enums will appear in the dropdown in the validation tool. - `hideEnumDetail` boolean — If true, the hoverable enum value detail icon will be hidden. - `dropNull` boolean — If True, any dropdown annotations that fail to parse to a value will be discarded - `enabledChildFields` Field[] - `disabledChildFields` Field[] - `slug` string, nullable - `displayRawText` boolean — If true, then the validation tool will show the user the raw text found on the page, not the value that has been parsed to a specific type. - `fields` object[], nullable - `disabledFields` Field[], required - `label` string, required - `dataPoint` string, required — Data point identifier - `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 - `mandatory` boolean - `autoValidationThreshold` number, nullable — Threshold for auto validation. If null, uses the collection's autoValidationThreshold. - `enableAutoValidationThreshold` boolean, nullable — If true, the autoValidationThreshold enable auto validation from the threshold from this field if specified, else from the collection - `showDropdown` boolean - `displayEnumValue` boolean — If true, both the value and the label for the enums will appear in the dropdown in the validation tool. - `hideEnumDetail` boolean — If true, the hoverable enum value detail icon will be hidden. - `dropNull` boolean — If True, any dropdown annotations that fail to parse to a value will be discarded - `enabledChildFields` Field[] - `disabledChildFields` Field[] - `slug` string, nullable - `displayRawText` boolean — If true, then the validation tool will show the user the raw text found on the page, not the value that has been parsed to a specific type. - `fields` object[], nullable - `fieldsConfigured` boolean - `dateFormatPreference` 'DMY' | 'MDY' | 'YMD', nullable - `dateFormatFromDocument` boolean, nullable — Predict the date format from any dates in the document that is not ambiguous. - `extractorConfig` ExtractorConfig, nullable — Extra configurations specific to an extractor. - `resumeRedact` RedactConfig - `redactHeadshot` boolean - `redactPersonalDetails` boolean - `redactWorkDetails` boolean - `redactReferees` boolean - `redactEducationDetails` boolean - `redactLocations` boolean - `redactDates` boolean - `redactGender` boolean - `unvalidatedDocsCount` integer, nullable — Number of unvalidated documents in the collection. - `confirmedDocsCount` integer, nullable — Number of validated documents in the collection. - `ingestEmail` string — When you send email to this address, any document attached in the body will be uploaded to this collection. - `tailoredExtractorRequested` boolean — Whether a tailored extractor has been requested for this collection. - `allowOpenai` boolean — Whether to allow OpenAI API to be used to assist in creating a model for this collection. - `trainsExtractor` boolean — Whether this collection feeds documents into the extractor's training queue. This setting can only be toggled for custom extractors. - `disableConfirmationIfValidationRulesFail` boolean — If True, users cannot validate documents with missing mandatory fields, or failing validation rules. - `autoRefreshValidationResults` boolean — If True, validation results are refreshed whenever annotations are changed. ## 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.md) · [All operations](https://skmtc.net/affinda/apis/affinda-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/affinda/affinda-api/versions/5f71e092a3e8/schema)