6772e50cb58e

latestOpenAPI 3.0.3MIT2026-08-04143307364.8 KB

Document API - Extractor

Get list of all extractors

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

get/v3/extractors

Query parameters

organizationstring required

Uniquely identify an organization.

Example:mEFayXdO

Filter by organization.

include_public_extractorsboolean

Whether to include Affinda's off-the-shelf extractors.

namestring

Filter by name.

validatableboolean

Filter by validatable.

Response

All matching extractors.

identifierstring required

Uniquely identify an extractor.

namestring required

namePluralstring required

categorystring nullable

validatableboolean required

isCustomboolean

createdDtstring date-time

lastTrainedDtstring date-time nullable

Example response

[
  {
    "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"
  }
]