6772e50cb58e

latestOpenAPI 3.0.3MIT2026-08-04143307364.8 KB

Deprecated End Points

Get specific collection

Return a specific collection.

get/v3/collections/{identifier}

Path parameters

identifierstring required

Uniquely identify a collection.

Example:mEFayXdO

Collection's identifier

Response

Successfully retrieved collection.

identifierstring required

Uniquely identify a collection.

namestring

autoValidationThresholdnumber

enableAutoValidationThresholdboolean

autoValidateIfValidationRulesPassboolean

fieldsConfiguredboolean

dateFormatPreference'DMY' | 'MDY' | 'YMD' nullable

dateFormatFromDocumentboolean nullable

Predict the date format from any dates in the document that is not ambiguous.

unvalidatedDocsCountinteger nullable

Number of unvalidated documents in the collection.

confirmedDocsCountinteger nullable

Number of validated documents in the collection.

ingestEmailstring

When you send email to this address, any document attached in the body will be uploaded to this collection.

tailoredExtractorRequestedboolean

Whether a tailored extractor has been requested for this collection.

allowOpenaiboolean

Whether to allow OpenAI API to be used to assist in creating a model for this collection.

trainsExtractorboolean

Whether this collection feeds documents into the extractor's training queue. This setting can only be toggled for custom extractors.

disableConfirmationIfValidationRulesFailboolean

If True, users cannot validate documents with missing mandatory fields, or failing validation rules.

autoRefreshValidationResultsboolean

If True, validation results are refreshed whenever annotations are changed.

Example response

{
  "identifier": "mEFayXdO",
  "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"
    }
  },
  "extractor": {
    "identifier": "resume",
    "baseExtractor": {
      "identifier": "resume"
    },
    "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"
    },
    "category": "Recruitment"
  },
  "extractorConfig": {
    "resumeRedact": {
      "redactHeadshot": true,
      "redactPersonalDetails": true,
      "redactWorkDetails": true,
      "redactReferees": true,
      "redactEducationDetails": true,
      "redactLocations": true,
      "redactDates": true,
      "redactGender": true
    }
  }
}