Organizations API

Get current organization

Retrieve the currently authenticated organization. A convenient alias of the Get organization endpoint.

For a complete reference of the organization object, refer to the Get organization endpoint documentation.

🔑 Access with

Advanced access token with organizations.read

OAuth access with organizations.read

get/v2/organizations/me

Request

  • Base URL
    https://api.mollie.com
  • URL
    https://api.mollie.com/v2/organizations/me
  • 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

Response

The current 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.

localestring nullable required

Sets the language for customer-facing content and communications.

Possible values: 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

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.

vatRegulationstring 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.

Possible values: dutch british shifted

Example response

{
  "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

No recorded changes to this operation across all 1 revision of this API.