MOmollie
Organizations API

Get organization

Changed on

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}

Request

  • Base URL
    https://api.mollie.com
  • URL
    https://api.mollie.com/v2/organizations/{organizationId}
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://my.mollie.com/oauth2/authorize
      Token URL: https://api.mollie.com/oauth2/tokens scopes: organizations.read

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.

resourcestring required

Indicates the response contains an organization object. Will always contain the string organization for this resource type.

idstring required
namestring required

The name of the organization.

emailstring required

The email address associated with the organization.

If the domain contains non-ASCII characters, encode it as Punycode per RFC 3492.

locale'ca_ES' | 'cs_CZ' | 'da_DK' | 'de_AT' | 'de_CH' | 'de_DE' | 'de_LU' | 'el_GR' | 'en_BE' | 'en_GB' | 'en_NL' | 'en_US' | 'es_ES' | 'fi_FI' | 'fr_BE' | 'fr_FR' | 'fr_LU' | 'hu_HU' | 'is_IS' | 'it_IT' | 'lt_LT' | 'lv_LV' | 'nb_NO' | 'nl_BE' | 'nl_NL' | 'pl_PL' | 'pt_PT' | 'sk_SK' | 'sl_SI' | 'sv_SE' | 'tr_TR' | 'null' nullable required

Sets the language for customer-facing content and communications.

registrationNumberstring nullable

The registration number of the organization at their local chamber of commerce.

vatNumberstring nullable

The VAT number of the organization, if based in the European Union or in The United Kingdom. VAT numbers are verified against the international registry VIES.

The field is not present for merchants residing in other countries.

vatRegulation'dutch' | 'british' | 'shifted' nullable

Mollie applies Dutch VAT for merchants based in The Netherlands, British VAT for merchants based in The United Kingdom, and shifted VAT for merchants in the European Union.

The field is not present for merchants residing in other countries.

Example response

{
  "resource": "organization",
  "id": "org_1234567",
  "name": "My Online Store",
  "email": "example@mail.com",
  "locale": "en_US",
  "address": {
    "streetAndNumber": "Keizersgracht 126",
    "postalCode": "1015 CW",
    "city": "Amsterdam",
    "country": "NL"
  },
  "registrationNumber": "12345678",
  "vatNumber": "NL123456789B01",
  "vatRegulation": "dutch",
  "_links": {
    "self": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "dashboard": {
      "href": "https://...",
      "type": "application/hal+json"
    },
    "documentation": {
      "href": "https://...",
      "type": "application/hal+json"
    }
  }
}

Changes

  • 9c1c6717ac7dRevision changes
    • warning

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

    • warning

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

    • warning

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

  • 86a9cd830b06Revision changes
    • warning

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

    • warning

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