Signicat Organization API

Provides management endpoints for Organizations.

Operations 5

GET /organizations List organizations #
POST /organizations Create organization #
GET /organizations/{organizationId} Retrieve organization #
PATCH /organizations/{organizationId} Update organization #
DELETE /organizations/{organizationId} Delete organization #

Documentation

📖
APIReference
https://developer.signicat.com/apis/data-verification/
📖
APIReference
https://developer.signicat.com/apis/digital-evidence-management/
📖
APIReference
https://developer.signicat.com/apis/eid-hub/
📖
APIReference
https://developer.signicat.com/apis/electronic-signing/sign-api-v2/
📖
APIReference
https://developer.signicat.com/apis/electronic-signing/enterprise/
📖
APIReference
https://developer.signicat.com/apis/electronic-signing/express/
📖
APIReference
https://developer.signicat.com/apis/archive/
📖
APIReference
https://developer.signicat.com/apis/id-document-and-biometric-verification/
📖
APIReference
https://developer.signicat.com/apis/mobileid/
📖
APIReference
https://developer.signicat.com/apis/mobileid-admin/
📖
APIReference
https://developer.signicat.com/apis/ongoing-monitoring/
📖
APIReference
https://developer.signicat.com/apis/person-monitoring/
📖
APIReference
https://developer.signicat.com/apis/reuseid-onboarding/
📖
APIReference
https://developer.signicat.com/apis/reuseid/
📖
APIReference
https://developer.signicat.com/apis/secure-share/
📖
APIReference
https://developer.signicat.com/apis/mint/
📖
APIReference
https://developer.signicat.com/apis/siam/
📖
APIReference
https://developer.signicat.com/apis/audit-logs/
📖
APIReference
https://developer.signicat.com/apis/account-management/
📖
APIReference
https://developer.signicat.com/apis/domain-management/
📖
APIReference
https://developer.signicat.com/apis/events/
📖
APIReference
https://developer.signicat.com/apis/oidc-config/
📖
APIReference
https://developer.signicat.com/apis/usage/

Specifications

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-organization-basic-info-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-person-basic-info-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-organization-ownership-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-business-registry-registration-authority-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-geodata-country-info-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-business-registry-registration-authority-item-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-query-request-body-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-record-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-query-record-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-stats-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-session-data-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-session-request-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-signing-session-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-document-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-document-collection-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-post-document-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-paginated-signing-session-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-merchant-sign-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-signing-order-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-task-status-info-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-forwarding-info-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-event-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-artifact-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-packaging-task-status-info-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-signer-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-update-signer-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-signer-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-document-summary-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-update-signer-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-attachment-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-archive-jsonld-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-archive-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-archive-archive-objects-representation-jsonld-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-archive-archive-patch-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-audit-log-jsonld-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-archive-direct-jsonld-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-capture-configuration-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-capture-configuration-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-process-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-process-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-process-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-match-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-signature-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-account-recovery-details-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-authentication-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-registration-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-user-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-idverification-add-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-application-config-properties-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-application-config-update-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-account-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-e2-ekey-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-apnstoken-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-account-platform-all-details-statistic-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-organisation-data-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-person-response-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-monitor-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-organisation-request-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-monitor-changes-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-create-monitor-request-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-monitor-person-get-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-monitor-create-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-base-monitor-person-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-monitor-get-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-person-changes-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-paged-collection-1-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-device-signature-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-device-registration-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-device-authentication-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-passkey-authentication-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-passkey-registration-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-create-share-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-create-recipient-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-update-recipient-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-update-share-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-share-response-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-recipient-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-journey-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-workflow-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-workflow-template-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-create-workflow-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-update-workflow-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-step-definition-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-user-resource-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-subject-custom-attribute-definition-resource-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-membership-custom-attribute-definition-resource-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-group-custom-attribute-definition-resource-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-membership-resource-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-organization-list-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-audit-log-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-query-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-audit-query-result-audit-log-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-query-metadata-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-query-metadata-response-event-type-properties-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-invoice-item-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-invoice-list-item-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-organization-read-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-account-read-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-organization-create-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-organization-write-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-domain-read-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-get-metadata-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-domain-create-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-check-domain-availability-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-domain-patch-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-check-dns-setup-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-subscription-get-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-subscription-update-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-subscription-event-delivery-attempt-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-subscription-create-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-event-log-item-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-page-subscription-list-item-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-client-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-patch-client-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-public-key-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-signicat-error-template-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-secret-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-custom-claim-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/signicat/json-schema/signicat-usage-set-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/signicat:signicat-organization-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

signicat-organization-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Signicat Organization API
  version: v1
  contact: ''
  license: ''
  termsOfService: ''
  description: 'Operations tagged Organization across 2 of this provider''s published API definitions: account-management-openapi.json, signicat-account-management-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: /account-management
tags:
- name: Organization
  description: Provides management endpoints for Organizations.
paths:
  /organizations:
    get:
      tags:
      - Organization
      summary: List organizations
      operationId: list_organizations
      parameters:
      - name: page
        in: query
        description: Opaque pagination token.
        schema:
          type: string
      - name: limit
        in: query
        description: Max results to return.
        schema:
          type: integer
          format: int32
          default: 50
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Page_OrganizationListItem'
              example:
                data:
                - id: o-p-0TgcUq7CylltM7OkwB4t
                  name: My Organization
                  lastModifiedDate: '2022-05-01T03:14:39Z'
                  entityId: '999000999'
                  entityVatNumber: null
                  entityLegalName: null
                  country: 'NO'
                  parentOrganization:
                    id: o-p-avKce97dOKlnAlOw2R55
                    name: My Parent Organization
                    url: https://api.signicat.com/account-management/organizations/o-p-avKce97dOKlnAlOw2R55
                  url: https://api.signicat.com/account-management/organizations/o-p-0TgcUq7CylltM7OkwB4t
                - id: o-p-avKce97dOKlnAlOw2R55
                  name: My Parent Organization
                  lastModifiedDate: ''
                  entityId: '111999555'
                  entityVatNumber: null
                  entityLegalName: null
                  country: 'NO'
                  parentOrganization: null
                  url: https://api.signicat.com/account-management/organizations/o-p-avKce97dOKlnAlOw2R55
                next: null
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Page_OrganizationListItem'
              example:
                data:
                - id: o-p-0TgcUq7CylltM7OkwB4t
                  name: My Organization
                  lastModifiedDate: '2022-05-01T03:14:39Z'
                  entityId: '999000999'
                  entityVatNumber: null
                  entityLegalName: null
                  country: 'NO'
                  parentOrganization:
                    id: o-p-avKce97dOKlnAlOw2R55
                    name: My Parent Organization
                    url: https://api.signicat.com/account-management/organizations/o-p-avKce97dOKlnAlOw2R55
                  url: https://api.signicat.com/account-management/organizations/o-p-0TgcUq7CylltM7OkwB4t
                - id: o-p-avKce97dOKlnAlOw2R55
                  name: My Parent Organization
                  lastModifiedDate: ''
                  entityId: '111999555'
                  entityVatNumber: null
                  entityLegalName: null
                  country: 'NO'
                  parentOrganization: null
                  url: https://api.signicat.com/account-management/organizations/o-p-avKce97dOKlnAlOw2R55
                next: null
    post:
      tags:
      - Organization
      summary: Create organization
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OrganizationCreate'
            example:
              name: My Organization
              website: https://myorg.com
              entityId: '999000999'
              entityVatNumber: null
              entityLegalName: null
              country: 'NO'
              billingEmail: billing@myorg.com
              billingAddress:
                street: Signistreet 39
                postalCode: '5089'
                city: Bergen
                region: null
                country: 'NO'
              parentOrganizationId: o-p-avKce97dOKlnAlOw2R55
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationRead'
              example:
                id: o-p-0TgcUq7CylltM7OkwB4t
                name: My Organization
                lastModifiedDate: '2022-05-01T03:14:39Z'
                website: https://myorg.com
                entityId: '999000999'
                entityVatNumber: null
                entityLegalName: null
                country: 'NO'
                billingEmail: billing@myorg.com
                billingAddress:
                  street: Signistreet 39
                  postalCode: '5089'
                  city: Bergen
                  region: null
                  country: 'NO'
                parentOrganization:
                  id: o-p-avKce97dOKlnAlOw2R55
                  name: My Parent Organization
                  url: https://api.signicat.com/account-management/organizations/o-p-avKce97dOKlnAlOw2R55
                childOrganizations: []
                billingContact:
                  id: c-p-5831eMDkMehkgq39L3KK
                  name: Harald Hårfagre
                  email: harald@hårfagre.no
                  mobile: '+4799999999'
                  url: https://api.signicat.com/account-management/contacts/c-p-5831eMDkMehkgq39L3KK
                  roles: null
                accounts:
                - id: a-ppge-ovC1eMDgt0hkgqZUSaPh
                  name: My Account
                  url: https://api.signicat.com/account-management/accounts/a-ppge-ovC1eMDgt0hkgqZUSaPh
                  isSandbox: false
                  enabled: true
                  region: EU
                  cloud: GCP
                  isSoftDeleted: null
                  softDeletedAt: null
                - id: a-spge-PmN5cDIdq0cz93ZUS276
                  name: My Sandbox Account
                  url: https://api.signicat.com/account-management/accounts/a-spge-PmN5cDIdq0cz93ZUS276
                  isSandbox: true
                  enabled: false
                  region: EU
                  cloud: GCP
                  isSoftDeleted: null
                  softDeletedAt: null
                contacts:
                - id: c-p-5831eMDkMehkgq39L3KK
                  name: Harald Hårfagre
                  email: harald@hårfagre.no
                  mobile: '+4799999999'
                  url: https://api.signicat.com/account-management/contacts/c-p-5831eMDkMehkgq39L3KK
                  roles: null
            application/problem+json:
              schema:
                $ref: '#/components/schemas/OrganizationRead'
              example:
                id: o-p-0TgcUq7CylltM7OkwB4t
                name: My Organization
                lastModifiedDate: '2022-05-01T03:14:39Z'
                website: https://myorg.com
                entityId: '999000999'
                entityVatNumber: null
                entityLegalName: null
                country: 'NO'
                billingEmail: billing@myorg.com
                billingAddress:
                  street: Signistreet 39
                  postalCode: '5089'
                  city: Bergen
                  region: null
                  country: 'NO'
                parentOrganization:
                  id: o-p-avKce97dOKlnAlOw2R55
                  name: My Parent Organization
                  url: https://api.signicat.com/account-management/organizations/o-p-avKce97dOKlnAlOw2R55
                childOrganizations: []
                billingContact:
                  id: c-p-5831eMDkMehkgq39L3KK
                  name: Harald Hårfagre
                  email: harald@hårfagre.no
                  mobile: '+4799999999'
                  url: https://api.signicat.com/account-management/contacts/c-p-5831eMDkMehkgq39L3KK
                  roles: null
                accounts:
                - id: a-ppge-ovC1eMDgt0hkgqZUSaPh
                  name: My Account
                  url: https://api.signicat.com/account-management/accounts/a-ppge-ovC1eMDgt0hkgqZUSaPh
                  isSandbox: false
                  enabled: true
                  region: EU
                  cloud: GCP
                  isSoftDeleted: null
                  softDeletedAt: null
                - id: a-spge-PmN5cDIdq0cz93ZUS276
                  name: My Sandbox Account
                  url: https://api.signicat.com/account-management/accounts/a-spge-PmN5cDIdq0cz93ZUS276
                  isSandbox: true
                  enabled: false
                  region: EU
                  cloud: GCP
                  isSoftDeleted: null
                  softDeletedAt: null
                contacts:
                - id: c-p-5831eMDkMehkgq39L3KK
                  name: Harald Hårfagre
                  email: harald@hårfagre.no
                  mobile: '+4799999999'
                  url: https://api.signicat.com/account-management/contacts/c-p-5831eMDkMehkgq39L3KK
                  roles: null
      operationId: postOrganizations
      x-operation-id-source: derived
    servers:
    - url: /account-management
  /organizations/{organizationId}:
    get:
      tags:
      - Organization
      summary: Retrieve organization
      operationId: retrieve_organization
      parameters:
      - name: organizationId
        in: path
        description: ''
        required: true
        schema:
          type: string
      - name: deletedAccounts
        in: query
        description: If true, the resulting `accounts` property will include currently soft-deleted accounts
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationRead'
              example:
                id: o-p-0TgcUq7CylltM7OkwB4t
                name: My Organization
                lastModifiedDate: '2022-05-01T03:14:39Z'
                website: https://myorg.com
                entityId: '999000999'
                entityVatNumber: null
                entityLegalName: null
                country: 'NO'
                billingEmail: billing@myorg.com
                billingAddress:
                  street: Signistreet 39
                  postalCode: '5089'
                  city: Bergen
                  region: null
                  country: 'NO'
                parentOrganization:
                  id: o-p-avKce97dOKlnAlOw2R55
                  name: My Parent Organization
                  url: https://api.signicat.com/account-management/organizations/o-p-avKce97dOKlnAlOw2R55
                childOrganizations: []
                billingContact:
                  id: c-p-5831eMDkMehkgq39L3KK
                  name: Harald Hårfagre
                  email: harald@hårfagre.no
                  mobile: '+4799999999'
                  url: https://api.signicat.com/account-management/contacts/c-p-5831eMDkMehkgq39L3KK
                  roles: null
                accounts:
                - id: a-ppge-ovC1eMDgt0hkgqZUSaPh
                  name: My Account
                  url: https://api.signicat.com/account-management/accounts/a-ppge-ovC1eMDgt0hkgqZUSaPh
                  isSandbox: false
                  enabled: true
                  region: EU
                  cloud: GCP
                  isSoftDeleted: null
                  softDeletedAt: null
                - id: a-spge-PmN5cDIdq0cz93ZUS276
                  name: My Sandbox Account
                  url: https://api.signicat.com/account-management/accounts/a-spge-PmN5cDIdq0cz93ZUS276
                  isSandbox: true
                  enabled: false
                  region: EU
                  cloud: GCP
                  isSoftDeleted: null
                  softDeletedAt: null
                contacts:
                - id: c-p-5831eMDkMehkgq39L3KK
                  name: Harald Hårfagre
                  email: harald@hårfagre.no
                  mobile: '+4799999999'
                  url: https://api.signicat.com/account-management/contacts/c-p-5831eMDkMehkgq39L3KK
                  roles: null
            application/problem+json:
              schema:
                $ref: '#/components/schemas/OrganizationRead'
              example:
                id: o-p-0TgcUq7CylltM7OkwB4t
                name: My Organization
                lastModifiedDate: '2022-05-01T03:14:39Z'
                website: https://myorg.com
                entityId: '999000999'
                entityVatNumber: null
                entityLegalName: null
                country: 'NO'
                billingEmail: billing@myorg.com
                billingAddress:
                  street: Signistreet 39
                  postalCode: '5089'
                  city: Bergen
                  region: null
                  country: 'NO'
                parentOrganization:
                  id: o-p-avKce97dOKlnAlOw2R55
                  name: My Parent Organization
                  url: https://api.signicat.com/account-management/organizations/o-p-avKce97dOKlnAlOw2R55
                childOrganizations: []
                billingContact:
                  id: c-p-5831eMDkMehkgq39L3KK
                  name: Harald Hårfagre
                  email: harald@hårfagre.no
                  mobile: '+4799999999'
                  url: https://api.signicat.com/account-management/contacts/c-p-5831eMDkMehkgq39L3KK
                  roles: null
                accounts:
                - id: a-ppge-ovC1eMDgt0hkgqZUSaPh
                  name: My Account
                  url: https://api.signicat.com/account-management/accounts/a-ppge-ovC1eMDgt0hkgqZUSaPh
                  isSandbox: false
                  enabled: true
                  region: EU
                  cloud: GCP
                  isSoftDeleted: null
                  softDeletedAt: null
                - id: a-spge-PmN5cDIdq0cz93ZUS276
                  name: My Sandbox Account
                  url: https://api.signicat.com/account-management/accounts/a-spge-PmN5cDIdq0cz93ZUS276
                  isSandbox: true
                  enabled: false
                  region: EU
                  cloud: GCP
                  isSoftDeleted: null
                  softDeletedAt: null
                contacts:
                - id: c-p-5831eMDkMehkgq39L3KK
                  name: Harald Hårfagre
                  email: harald@hårfagre.no
                  mobile: '+4799999999'
                  url: https://api.signicat.com/account-management/contacts/c-p-5831eMDkMehkgq39L3KK
                  roles: null
    patch:
      tags:
      - Organization
      summary: Update organization
      parameters:
      - name: organizationId
        in: path
        description: ''
        required: true
        schema:
          type: string
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OrganizationWrite'
            example:
              name: My Organization
              website: https://myorg.com
              entityId: '999000999'
              entityVatNumber: null
              entityLegalName: null
              country: 'NO'
              billingEmail: billing@myorg.com
              billingAddress:
                street: Signistreet 39
                postalCode: '5089'
                city: Bergen
                region: null
                country: 'NO'
              billingContactId: c-p-5831eMDkMehkgq39L3KK
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationWrite'
              example:
                name: My Organization
                website: https://myorg.com
                entityId: '999000999'
                entityVatNumber: null
                entityLegalName: null
                country: 'NO'
                billingEmail: billing@myorg.com
                billingAddress:
                  street: Signistreet 39
                  postalCode: '5089'
                  city: Bergen
                  region: null
                  country: 'NO'
                billingContactId: c-p-5831eMDkMehkgq39L3KK
            application/problem+json:
              schema:
                $ref: '#/components/schemas/OrganizationWrite'
              example:
                name: My Organization
                website: https://myorg.com
                entityId: '999000999'
                entityVatNumber: null
                entityLegalName: null
                country: 'NO'
                billingEmail: billing@myorg.com
                billingAddress:
                  street: Signistreet 39
                  postalCode: '5089'
                  city: Bergen
                  region: null
                  country: 'NO'
                billingContactId: c-p-5831eMDkMehkgq39L3KK
      operationId: patchOrganizationsByOrganizationId
      x-operation-id-source: derived
    delete:
      tags:
      - Organization
      summary: Delete organization
      parameters:
      - name: organizationId
        in: path
        description: ''
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
      operationId: deleteOrganizationsByOrganizationId
      x-operation-id-source: derived
    servers:
    - url: /account-management
components:
  schemas:
    OrganizationRead:
      type: object
      properties:
        id:
          type: string
          description: Globally unique ID of organization
        name:
          type: string
          description: Name
        lastModifiedDate:
          type: string
          description: Timestamp of last organization modification.
        website:
          type:
          - string
          - 'null'
          description: Home page
        entityId:
          type:
          - string
          - 'null'
          description: Organization Entity ID / Org.no
        entityVatNumber:
          type:
          - string
          - 'null'
          description: VAT Number
        entityLegalName:
          type:
          - string
          - 'null'
          description: Legal name of the entity / organization
        country:
          type:
          - string
          - 'null'
          description: Country the organization is registered in
        billingEmail:
          type:
          - string
          - 'null'
          description: Billing email
        billingAddress:
          allOf:
          - $ref: '#/components/schemas/Address'
          description: Billing address
        parentOrganization:
          allOf:
          - $ref: '#/components/schemas/OrganizationChildListItem'
          description: The parent organization
        childOrganizations:
          type: array
          items:
            $ref: '#/components/schemas/OrganizationChildListItem'
          description: The child organizations
        billingContact:
          allOf:
          - $ref: '#/components/schemas/ContactChildListItem'
          description: Billing contact person
        accounts:
          type: array
          items:
            $ref: '#/components/schemas/AccountChildListItem'
          description: The organization accounts
        contacts:
          type: array
          items:
            $ref: '#/components/schemas/ContactChildListItem'
          description: The organization contacts
      additionalProperties: false
    OrganizationChildListItem:
      type: object
      properties:
        id:
          type: string
          description: Globally unique ID of organization
        name:
          type: string
          description: Name
        url:
          type: string
          description: API URL to retrieve Organization object
      additionalProperties: false
      description: Suborganization of an organization.
    OrganizationListItem:
      type: object
      properties:
        id:
          type: string
          description: Globally unique ID of organization
        name:
          type: string
          description: Name
        lastModifiedDate:
          type: string
          description: Timestamp of last organization modification.
        entityId:
          type:
          - string
          - 'null'
          description: Organization Entity ID / Org.no
        entityVatNumber:
          type:
          - string
          - 'null'
          description: VAT Number
        entityLegalName:
          type:
          - string
          - 'null'
          description: Legal name of the entity / organization
        country:
          type:
          - string
          - 'null'
          description: Country the organization is registered in
        parentOrganization:
          allOf:
          - $ref: '#/components/schemas/OrganizationChildListItem'
          description: The parent organization
        url:
          type: string
          description: API URL to retrieve Organization object
      additionalProperties: false
    AccountChildListItem:
      type: object
      properties:
        id:
          type: string
          description: Globally unique ID of account
          example: a-ppge-ovC1eMDgt0hkgqZUSaPh
        name:
          type: string
          description: Display name
          example: My Account
        url:
          type: string
          description: API URL to retrieve Account object
          example: https://api.signicat.com/account-management/accounts/a-ppge-ovC1eMDgt0hkgqZUSaPh
        isSandbox:
          type:
          - boolean
          - 'null'
          description: Whether the account is a sandbox account
          example: 'false'
        enabled:
          type: boolean
          description: Whether the account is enabled
          example: 'true'
        region:
          type: string
          description: Which region the account belongs to
          example: EU
        cloud:
          type: string
          description: Which cloud the account belongs to
          example: GCP
        isSoftDeleted:
          type:
          - boolean
          - 'null'
          description: If true, the account has been soft deleted and will soon be permanently deleted.
          example: '`null`'
        softDeletedAt:
          type:
          - string
          - 'null'
          description: Timestamp of when account was soft deleted.
          example: 'null'
      additionalProperties: false
      description: Account of an organization.
    ContactChildListItem:
      type: object
      properties:
        id:
          type: string
          description: Globally unique ID of contact
        name:
          type: string
          description: Display name
        email:
          type:
          - string
          - 'null'
          description: Email address
        mobile:
          type:
          - string
          - 'null'
          description: Mobile phone number
        url:
          type: string
          description: API URL to retrieve Contact object
        roles:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ContactRole'
          description: Roles of the contact
      additionalProperties: false
      description: Contact of an organization.
    Page_OrganizationListItem:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/OrganizationListItem'
          description: The contents of the current page.
        next:
          type:
          - string
          - 'null'
          description: URL to the next page, if more data may be available.
      additionalProperties: false
    OrganizationCreate:
      required:
      - name
      - parentOrganizationId
      type: object
      properties:
        name:
          maxLength: 80
          minLength: 3
          type: string
          description: Name
        website:
          maxLength: 255
          minLength: 0
          type:
          - string
          - 'null'
          description: Home page
        entityId:
          maxLength: 100
          minLength: 0
          type:
          - string
          - 'null'
          description: Organization Entity ID / Org.no
        entityVatNumber:
          maxLength: 255
          minLength: 0
          type:
          - string
          - 'null'
          description: VAT Number
        entityLegalName:
          maxLength: 255
          minLength: 0
          type:
          - string
          - 'null'
          description: Legal name of the entity / organization
        country:
          maxLength: 2
          minLength: 2
          type:
          - string
          - 'null'
          description: Country the organization is registered in
        billingEmail:
          maxLength: 80
          minLength: 0
          type:
          - string
          - 'null'
          description: Billing email
          format: email
        billingAddress:
          allOf:
          - $ref: '#/components/schemas/Address'
          description: Billing address
        parentOrganizationId:
          minLength: 1
          type: string
          description: The parent organization of the organization
      additionalProperties: false
    OrganizationWrite:
      type: object
      properties:
        name:
          maxLength: 80
          minLength: 3
          type:
          - string
          - 'null'
          description: Name
        website:
          maxLength: 255
          minLength: 0
          type:
          - string
          - 'null'
          description: Home page
        entityId:
          maxLength: 100
          minLength: 0
          type:
          - string
          - 'null'
          description: Organization Entity ID / Org.no
        entityVatNumber:
          maxLength: 255
          minLength: 0
          type:
          - string
          - 'null'
          description: VAT Number
        entityLegalName:
          maxLength: 255
          minLength: 0
          type:
          - string
          - 'null'
          description: Legal name of the entity / organization
        country:
          maxLength: 2
          minLength: 2
          type:
          - string
          - 'null'
          description: Country the organization is registered in
        billingEmail:
          maxLength: 80
          minLength: 0
          type:
          - string
          - 'null'
          description: Billing email
          format: email
        billingAddress:
          allOf:
          - $ref: '#/components/schemas/Address'
          description: Billing address
        billingContactId:
          type:
          - string
          - 'null'
          description: ID of the billing contact person
      additionalProperties: false
    Address:
      type: object
      properties:
        street:
          maxLength: 255
          minLength: 0
          type:
          - string
          - 'null'
          description: Street. May be multiline.
        postalCode:
          maxLength: 20
          minLength: 0
          type:
          - string
          - 'null'
          description: Postal Code / Zip Code
        city:
          maxLength: 40
          minLength: 0
          type:
          - string
          - 'null'
          description: City
        region:
          maxLength: 80
          minLength: 0
          type:
          - string
          - 'null'
          description: Region / State
        country:
          maxLength: 2
          minLength: 2
          type:
          - string
          - 'null'
          description: Country.
      additionalProperties: false
    ContactRole:
      enum:
      - Other
      - CommercialOwner
      - MainTechnicalContact
      - FinancialContact
      type: string
x-refined-from:
- account-management-openapi.json
- signicat-account-management-openapi.yml