Organizations API

Get organization

Retrieve a single organization by its ID.

You can normally only retrieve the currently authenticated organization with this endpoint. This is primarily useful for OAuth apps. See also Get current organization.

If you have a partner account', you can retrieve organization details of connected organizations.

get/v2/organizations/{organizationId}

Query parameters

testmodeboolean

You can enable test mode by setting the testmode query parameter to true.

Test entities cannot be retrieved when the endpoint is set to live mode, and vice versa.

Headers

idempotency-keystring
Example:123e4567-e89b-12d3-a456-426

A unique key to ensure idempotent requests. This key should be a UUID v4 string.

Response

The organization object.

Changes

Changed in 8 of the 92 revisions of this API.1104

    • ●

      added the new el_GR enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new sl_SI enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new tr_TR enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new en_BE enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new en_NL enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new undefined enum value to the //// response property for the response status

      response-property-enum-value-added

    • ○

      removed the null enum value from the //// response property for the response status

      response-property-enum-value-removed

    • ●

      added the new cs_CZ enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new sk_SK enum value to the //// response property for the response status

      response-property-enum-value-added

    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      the endpoint scheme security advancedAccessToken was added to the API

      api-security-added

    • ○

      the endpoint scheme security organizationAccessToken was removed from the API

      api-security-removed

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ●

      added the new de_LU enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new fr_LU enum value to the //// response property for the response status

      response-property-enum-value-added

Of the 92 revisions, 9 have no diff computed.