GET
/
v3
/
workspaces
Get list of all workspaces
curl --request GET \
  --url https://{region}.affinda.com/v3/workspaces \
  --header 'Authorization: Bearer <token>'
[
  {
    "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>",
    "visibility": "organization",
    "collections": [
      {
        "identifier": "mEFayXdO",
        "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"
          },
          "category": "Recruitment",
          "validatable": true,
          "isCustom": true,
          "createdDt": "2023-11-07T05:31:56Z"
        },
        "unvalidatedDocsCount": 1,
        "confirmedDocsCount": 1
      }
    ],
    "rejectInvalidDocuments": true,
    "rejectDuplicates": true,
    "members": [
      {
        "id": 1,
        "name": "Carl Johnson",
        "username": "carljohnson",
        "email": "carljohnson@grove.street",
        "avatar": "https://affinda-api.s3.amazonaws.com/media/user-avatar.png?AWSAccessKeyId=KEY&Signature=SIG"
      }
    ],
    "unvalidatedDocsCount": 1,
    "confirmedDocsCount": 1,
    "ingestEmail": "<string>",
    "whitelistIngestAddresses": [
      "*@eyefind.info"
    ],
    "documentSplitter": {
      "identifier": "NqIvMvZl",
      "name": "<string>"
    }
  }
]

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

organization
string
required

Filter by organization.

Example:

"mEFayXdO"

name
string

Filter by name.

Response

200
application/json

All matching workspaces.

The response is of type object[].