---
title: "Get detail of an organization"
method: GET
path: "/v3/organizations/{identifier}"
tags: ["Organizations"]
---

# Get detail of an organization

`GET /v3/organizations/{identifier}`

Get detail of an organization.

## Path parameters

- `identifier` string, required — Uniquely identify an organization.

## Response `200`

Successfully retrieved organization.

- Organization
  - `identifier` string, required — Uniquely identify an organization.
  - `name` string, required
  - `userRole` 'admin' | 'member', required
  - `avatar` string, nullable, required — URL of the organization's avatar.
  - `resthookSignatureKey` string, nullable, required — Used to sign webhook payloads so you can verify their integrity.
  - `isTrial` boolean, required
  - `validationToolConfig` object, nullable, required — Configuration of the embeddable validation tool.
    - `theme` ThemeConfig
      - `palette` object
        - `mode` 'light' | 'dark'
        - `background` union
          - string
          - object
            - `default` string
            - `paper` string
        - `text` object
          - `primary` string
          - `secondary` string
          - `disabled` string
        - `divider` string
        - `primary` PaletteColorOptions
          - `main` string, required
          - `light` string
          - `dark` string
          - `contrastText` string
        - `secondary` PaletteColorOptions
          - `main` string, required
          - `light` string
          - `dark` string
          - `contrastText` string
        - `success` PaletteColorOptions
          - `main` string, required
          - `light` string
          - `dark` string
          - `contrastText` string
        - `annotation` PaletteColorOptions
          - `main` string, required
          - `light` string
          - `dark` string
          - `contrastText` string
        - `error` PaletteColorOptions
          - `main` string, required
          - `light` string
          - `dark` string
          - `contrastText` string
        - `info` PaletteColorOptions
          - `main` string, required
          - `light` string
          - `dark` string
          - `contrastText` string
        - `warning` PaletteColorOptions
          - `main` string, required
          - `light` string
          - `dark` string
          - `contrastText` string
      - `typography` object
        - `fontFamily` string
        - `fontSize` union
          - string
          - number
        - `fontWeightRegular` string
        - `fontWeightMedium` string
        - `fontWeightBold` string
      - `borderRadius` number
      - `fontUrl` string
    - `hideActions` boolean — Hide the confirm document button and other actions.
    - `hideCollection` boolean — Hide the collection selector.
    - `hideEditPages` boolean — Hide the edit pages button.
    - `hideExport` boolean — Hide the export menu.
    - `hideFilename` boolean — Hide the filename input.
    - `hideShowRawValues` boolean — Hide the toggle for showing raw annotation values.
    - `hideReject` boolean — Hide the reject document button.
    - `hideReparse` boolean — Hide the reparse button.
    - `hideRunOcr` boolean — Hide the run OCR button.
    - `hideTags` boolean — Hide the tags editor.
    - `hideWarnings` boolean — Hide the warnings panel.
    - `restrictDocumentSplitting` boolean — Disable the page editor after a document has been split once.
    - `disableCurrencyFormatting` boolean — Disable currency formatting of decimals values.
    - `disableEditDocumentMetadata` boolean — Disable editing document metadata. Makes the collection selector, filename input and tags editor read only.
    - `disableManualAnnotationEditing` boolean — Disable manual editing of annotation values via the validation popover.
    - `hideDocumentStatus` boolean — Hide the document status indicator in the toolbar.
  - `showCustomFieldCreation` boolean, required — Whether to show the custom field creation in the UI.
  - `allowDataSourceRecordCreation` boolean, required — Allow reviewers to create missing records from the data source selector. Keep disabled when data sources are managed by external system syncs.

## Other responses

- `400` — Bad request. If it is a validation error will contain a list of each invalid field
- `401` — Authorisation error
- `default` — UnexpectedError

---

[API](https://skmtc.net/affinda/apis/affinda-api-2.md) · [All operations](https://skmtc.net/affinda/apis/affinda-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/affinda/affinda-api-2/versions/6772e50cb58e/schema)