GET
/
v3
/
collections
Get list of all collections
curl --request GET \
  --url https://{region}.affinda.com/v3/collections \
  --header 'Authorization: Bearer <token>'
[
  {
    "identifier": "mEFayXdO",
    "name": "<string>",
    "workspace": {
      "identifier": "mEFayXdO",
      "organization": {
        "identifier": "mEFayXdO",
        "name": "Grove Street King",
        "userRole": "admin",
        "avatar": "https://affinda-api.s3.amazonaws.com/media/org-avatar.png?AWSAccessKeyId=KEY&Signature=SIG",
        "resthookSignatureKey": "465c6598bd34c0558f0ce256c43209d49fa85b0ff3e4c18b24e408b7563143ad",
        "isTrial": true,
        "validationToolConfig": {
          "theme": {
            "palette": {
              "mode": "light",
              "background": "<string>",
              "text": {
                "primary": "<string>",
                "secondary": "<string>",
                "disabled": "<string>"
              },
              "divider": "<string>",
              "primary": {
                "main": "<string>",
                "light": "<string>",
                "dark": "<string>",
                "contrastText": "<string>"
              },
              "secondary": {
                "main": "<string>",
                "light": "<string>",
                "dark": "<string>",
                "contrastText": "<string>"
              },
              "success": {
                "main": "<string>",
                "light": "<string>",
                "dark": "<string>",
                "contrastText": "<string>"
              },
              "annotation": {
                "main": "<string>",
                "light": "<string>",
                "dark": "<string>",
                "contrastText": "<string>"
              },
              "error": {
                "main": "<string>",
                "light": "<string>",
                "dark": "<string>",
                "contrastText": "<string>"
              },
              "info": {
                "main": "<string>",
                "light": "<string>",
                "dark": "<string>",
                "contrastText": "<string>"
              },
              "warning": {
                "main": "<string>",
                "light": "<string>",
                "dark": "<string>",
                "contrastText": "<string>"
              }
            },
            "typography": {
              "fontFamily": "<string>",
              "fontSize": "<string>",
              "fontWeightRegular": "<string>",
              "fontWeightMedium": "<string>",
              "fontWeightBold": "<string>"
            },
            "borderRadius": 123,
            "fontUrl": "<string>"
          },
          "hideActions": true,
          "hideCollection": true,
          "hideEditPages": true,
          "hideExport": true,
          "hideFilename": true,
          "hideReject": true,
          "hideReparse": true,
          "hideRunOcr": true,
          "hideTags": true,
          "hideWarnings": true,
          "restrictDocumentSplitting": true,
          "disableCurrencyFormatting": true,
          "disableEditDocumentMetadata": true
        },
        "showCustomFieldCreation": true
      },
      "name": "<string>"
    },
    "extractor": {
      "identifier": "resume",
      "name": "<string>",
      "namePlural": "<string>",
      "baseExtractor": {
        "identifier": "resume",
        "name": "<string>",
        "namePlural": "<string>",
        "validatable": true,
        "isCustom": true,
        "createdDt": "2023-11-07T05:31:56Z"
      },
      "organization": {
        "identifier": "mEFayXdO",
        "name": "Grove Street King",
        "userRole": "admin",
        "avatar": "https://affinda-api.s3.amazonaws.com/media/org-avatar.png?AWSAccessKeyId=KEY&Signature=SIG",
        "resthookSignatureKey": "465c6598bd34c0558f0ce256c43209d49fa85b0ff3e4c18b24e408b7563143ad",
        "isTrial": true,
        "validationToolConfig": {
          "theme": {
            "palette": {
              "mode": "light",
              "background": "<string>",
              "text": {
                "primary": "<string>",
                "secondary": "<string>",
                "disabled": "<string>"
              },
              "divider": "<string>",
              "primary": {
                "main": "<string>",
                "light": "<string>",
                "dark": "<string>",
                "contrastText": "<string>"
              },
              "secondary": {
                "main": "<string>",
                "light": "<string>",
                "dark": "<string>",
                "contrastText": "<string>"
              },
              "success": {
                "main": "<string>",
                "light": "<string>",
                "dark": "<string>",
                "contrastText": "<string>"
              },
              "annotation": {
                "main": "<string>",
                "light": "<string>",
                "dark": "<string>",
                "contrastText": "<string>"
              },
              "error": {
                "main": "<string>",
                "light": "<string>",
                "dark": "<string>",
                "contrastText": "<string>"
              },
              "info": {
                "main": "<string>",
                "light": "<string>",
                "dark": "<string>",
                "contrastText": "<string>"
              },
              "warning": {
                "main": "<string>",
                "light": "<string>",
                "dark": "<string>",
                "contrastText": "<string>"
              }
            },
            "typography": {
              "fontFamily": "<string>",
              "fontSize": "<string>",
              "fontWeightRegular": "<string>",
              "fontWeightMedium": "<string>",
              "fontWeightBold": "<string>"
            },
            "borderRadius": 123,
            "fontUrl": "<string>"
          },
          "hideActions": true,
          "hideCollection": true,
          "hideEditPages": true,
          "hideExport": true,
          "hideFilename": true,
          "hideReject": true,
          "hideReparse": true,
          "hideRunOcr": true,
          "hideTags": true,
          "hideWarnings": true,
          "restrictDocumentSplitting": true,
          "disableCurrencyFormatting": true,
          "disableEditDocumentMetadata": true
        },
        "showCustomFieldCreation": true
      },
      "category": "Recruitment",
      "validatable": true,
      "isCustom": true,
      "fieldGroups": [
        {
          "label": "<string>",
          "fields": [
            {
              "label": "<string>",
              "slug": "<string>",
              "fieldType": "text",
              "dataSource": "<string>",
              "mapping": "<string>",
              "dataPoint": "<string>",
              "mandatory": true,
              "disabled": true,
              "autoValidationThreshold": 123,
              "showDropdown": true,
              "displayRawText": true,
              "dropNull": true,
              "displayEnumValue": true,
              "fields": [
                {}
              ]
            }
          ]
        }
      ],
      "createdDt": "2023-11-07T05:31:56Z",
      "lastTrainedDt": "2023-11-07T05:31:56Z"
    },
    "autoValidationThreshold": 123,
    "enableAutoValidationThreshold": false,
    "autoValidateIfValidationRulesPass": false,
    "fields": [
      {
        "label": "<string>",
        "fields": [
          {
            "label": "<string>",
            "slug": "<string>",
            "fieldType": "text",
            "dataSource": "<string>",
            "mapping": "<string>",
            "dataPoint": "<string>",
            "mandatory": true,
            "disabled": true,
            "autoValidationThreshold": 123,
            "showDropdown": true,
            "displayRawText": true,
            "dropNull": true,
            "displayEnumValue": true,
            "fields": [
              {}
            ]
          }
        ]
      }
    ],
    "fieldsLayout": {
      "defaultCategory": {
        "label": "<string>",
        "enabledFields": [
          {
            "label": "<string>",
            "dataPoint": "<string>",
            "fieldType": "text",
            "dataSource": "<string>",
            "mapping": "<string>",
            "mandatory": true,
            "autoValidationThreshold": 0.5,
            "enableAutoValidationThreshold": true,
            "showDropdown": true,
            "displayEnumValue": true,
            "hideEnumDetail": true,
            "dropNull": true,
            "enabledChildFields": [
              {}
            ],
            "disabledChildFields": [
              {}
            ],
            "slug": "<string>",
            "displayRawText": true,
            "fields": [
              {}
            ]
          }
        ],
        "disabledFields": [
          {
            "label": "<string>",
            "dataPoint": "<string>",
            "fieldType": "text",
            "dataSource": "<string>",
            "mapping": "<string>",
            "mandatory": true,
            "autoValidationThreshold": 0.5,
            "enableAutoValidationThreshold": true,
            "showDropdown": true,
            "displayEnumValue": true,
            "hideEnumDetail": true,
            "dropNull": true,
            "enabledChildFields": [
              {}
            ],
            "disabledChildFields": [
              {}
            ],
            "slug": "<string>",
            "displayRawText": true,
            "fields": [
              {}
            ]
          }
        ]
      },
      "categories": [
        {
          "label": "<string>",
          "enabledFields": [
            {
              "label": "<string>",
              "dataPoint": "<string>",
              "fieldType": "text",
              "dataSource": "<string>",
              "mapping": "<string>",
              "mandatory": true,
              "autoValidationThreshold": 0.5,
              "enableAutoValidationThreshold": true,
              "showDropdown": true,
              "displayEnumValue": true,
              "hideEnumDetail": true,
              "dropNull": true,
              "enabledChildFields": [
                {}
              ],
              "disabledChildFields": [
                {}
              ],
              "slug": "<string>",
              "displayRawText": true,
              "fields": [
                {}
              ]
            }
          ],
          "disabledFields": [
            {
              "label": "<string>",
              "dataPoint": "<string>",
              "fieldType": "text",
              "dataSource": "<string>",
              "mapping": "<string>",
              "mandatory": true,
              "autoValidationThreshold": 0.5,
              "enableAutoValidationThreshold": true,
              "showDropdown": true,
              "displayEnumValue": true,
              "hideEnumDetail": true,
              "dropNull": true,
              "enabledChildFields": [
                {}
              ],
              "disabledChildFields": [
                {}
              ],
              "slug": "<string>",
              "displayRawText": true,
              "fields": [
                {}
              ]
            }
          ]
        }
      ]
    },
    "fieldsConfigured": true,
    "dateFormatPreference": "DMY",
    "dateFormatFromDocument": true,
    "extractorConfig": {
      "resumeRedact": {
        "redactHeadshot": true,
        "redactPersonalDetails": true,
        "redactWorkDetails": true,
        "redactReferees": true,
        "redactEducationDetails": true,
        "redactLocations": true,
        "redactDates": true,
        "redactGender": true
      }
    },
    "unvalidatedDocsCount": 1,
    "confirmedDocsCount": 1,
    "ingestEmail": "<string>",
    "tailoredExtractorRequested": true,
    "allowOpenai": false,
    "trainsExtractor": true,
    "disableConfirmationIfValidationRulesFail": false,
    "autoRefreshValidationResults": true
  }
]

Authorizations

Authorization
string
header
required

Basic authentication using an API key, e.g. {Authorization: Bearer aff_0bb4fbdf97b7e4111ff6c0015471094155f91}. You can find your API key within the Settings page of the Affinda web app. You can obtain an API key by signing up for a free trial.

Query Parameters

workspace
string
required

Filter by workspace.

Example:

"mEFayXdO"

Response

200
application/json

All matching collections.

The response is of type object[].