GET
/
v3
/
organizations
Get list of all organizations
curl --request GET \
  --url https://{region}.affinda.com/v3/organizations \
  --header 'Authorization: Bearer <token>'
[
  {
    "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
  }
]

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.

Response

All organizations you created or joined.

identifier
string

Uniquely identify an organization.

Example:

"mEFayXdO"

name
string
Example:

"Grove Street King"

userRole
enum<string>

The role of the logged in user within the organization.

Available options:
admin,
member
Example:

"admin"

avatar
string | null

URL of the organization's avatar.

Example:

"https://affinda-api.s3.amazonaws.com/media/org-avatar.png?AWSAccessKeyId=KEY&Signature=SIG"

resthookSignatureKey
string | null

Used to sign webhook payloads so you can verify their integrity.

Example:

"465c6598bd34c0558f0ce256c43209d49fa85b0ff3e4c18b24e408b7563143ad"

isTrial
boolean
validationToolConfig
object | null

Configuration of the embeddable validation tool.

showCustomFieldCreation
boolean

Whether to show the custom field creation in the UI.