v2

latestOpenAPI 3.0.3raw.githubusercontent.com2025-01-245593419.2 KB
Memberships

Get details of a single membership

OAuth scope: membership.read


Retrieve the details of the authenticated Membership.


The response contains the following attributes:

  • id - The membership's id
  • first_name - The first name of the membership
  • last_name - The last name of the membership
  • email - The email address of the membership
  • phone_number - The phone number of the membership
  • position - The professional position of the membership within the company (e.g.: CEO, financial manager)
  • status - Status of the membership (e.g: active)
  • role - The set of permissions of the membership within the organization's account (e.g.: owner, admin).
  • locale - The language chosen by the membership
  • team_id - The team's id that the membership belongs to
get/v2/membership

Headers

X-Qonto-Staging-Tokenstring

Required only for Sandbox API requests; to get one, please submit the following form: https://getqonto.atlassian.net/servicedesk/customer/portal/5/group/47/create/143.

Response

returns a membership. The membership returned is determined from the secret-key or OAuth2 token.

Example response

{
  "membership": {
    "id": "c9f9f051-7558-451c-b310-f4b8521424aa",
    "first_name": "Bruce Thomas Patrick",
    "last_name": "Wayne",
    "email": "batman@dc-comics.com",
    "phone_number": "+49123456789",
    "position": "Criminals threatener",
    "status": "active",
    "role": "owner",
    "locale": "de",
    "team_id": "d1f9f066-5642-462d-b421-a7d8521556bc"
  }
}