---
title: "Retrieve organization"
method: GET
path: "/api/v1/organizations/{organizationID}"
tags: ["Organization"]
---

# Retrieve organization

`GET /api/v1/organizations/{organizationID}`

Get an organization object.

## Response `200`

OK

- Organization
  - `id` integer, required — ID of the organization.
  - `name` string, required — Name of the organization (not visible in UI).
  - `url` string, uri, required — URL of the organization.
  - `workspaces` string[], required — List of workspaces objects in the organization.
  - `users` string[], required — List of users in the organization.
  - `organization_group` string, uri, required — URL to organization group the organization belongs to.
  - `ui_settings` object, required — Organization-wide frontend UI settings (e.g. locales). Rossum internal.
  - `metadata` Metadata, required — Client data. May be used to store e.g. external system object IDs. See [Metadata](/guides/overview#metadata) for more details.
  - `is_trial` boolean, required — Property indicates whether this license is a trial license.
  - `created_at` string, date-time, required — Timestamp for when the organization was created.
  - `trial_expires_at` string, date-time, nullable — Timestamp for when the trial period ended (ISO 8601).
  - `oidc_provider` string, nullable — (Deprecated) OpenID Connect provider name.
  - `internal_info` object, nullable — **INTERNAL** Rossum internal information on organization.
    - `cs_account_classification` string, nullable — Account classification in SalesForce.
    - `customer_type` string, nullable — Customer type in SalesForce.
    - `market_category` string, nullable — Customer market category in SalesForce.
    - `overdue_payment_date` string, date-time, nullable — Date of overdue payment. If empty, no payment is overdue. There may be a delay between update of the value of this field and the actual payment settlement with the Finance team and/or other customer-facing teams.
    - `sso_active` boolean, nullable — Customer has SSO login enabled.
  - `creator` string, uri, nullable — URL of the first user of the organization (set during organization creation).
  - `modified_by` string, uri, nullable, required — User that last modified the object.
  - `modified_at` string, date-time, nullable, required — Timestamp of last modification.
  - `settings` object, required — Settings of the organization.
    - `annotation_list_table` object — Configuration of annotation dashboard columns.
      - `columns` AnnotationListTable[] — Configuration of columns on annotation list.
        - `visible` boolean — Column is visible on the dashboard.
        - `width` number, float — Width of the column.
        - `column_type` 'meta' | 'schema' — Type of the field (`meta` - annotation meta field, `schema` - annotation content field).
        - `schema_id` string — `schema_id` of the extracted field (only for `column_type=schema`).
        - `data_type` 'date' | 'number' | 'string' | 'boolean' — Data type of the extracted field (only for `column_type=schema`). Allowed values are `date`, `number`, `string`, `boolean`.
        - `meta_type` string — Meta column type (only for `column_type=meta`). Allowed values can be found in `meta_field` table (+ additionally `details`).
    - `request_dashboard_table` object — Configuration of request dashboard columns.
      - `columns` AnnotationListTable[] — Configuration of columns on request dashboard.
        - `visible` boolean — Column is visible on the dashboard.
        - `width` number, float — Width of the column.
        - `column_type` 'meta' | 'schema' — Type of the field (`meta` - annotation meta field, `schema` - annotation content field).
        - `schema_id` string — `schema_id` of the extracted field (only for `column_type=schema`).
        - `data_type` 'date' | 'number' | 'string' | 'boolean' — Data type of the extracted field (only for `column_type=schema`). Allowed values are `date`, `number`, `string`, `boolean`.
        - `meta_type` string — Meta column type (only for `column_type=meta`). Allowed values can be found in `meta_field` table (+ additionally `details`).
  - `sandbox` boolean, required — Specifies if the organization is a sandbox.

## Other responses

- `400` — Invalid input data.
- `401` — The username/password is invalid or token is invalid (e.g. expired).
- `403` — Insufficient permission, missing authentication, invalid CSRF token and similar issue.
- `404` — The specified resource was not found.
- `409` — Conflict
- `429` — Request rate is too high, wait before sending more requests. See [Rate Limiting](/guides/overview#rate-limiting) for more details.
- `500` — Server failure while processing the request.
- `502` — Invalid response from the upstream server.
- `503` — We're temporarily offline for maintenance. Please try again later.
- `504` — Upstream server could not complete the request in time.

---

[API](https://skmtc.dev/rossum/apis/rossum-api.md) · [All operations](https://skmtc.dev/rossum/apis/rossum-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/rossum/rossum-api/revisions/f1b5a910991d/schema)