Retrieve Current Organization

GET

https://mapi.storyblok.com/v1/orgs/me

Returns the organization object for the currently authenticated user, including users, spaces, invitations, and pricing plan details.

Response properties

• org object

  The organization object.

  Show child properties

  • name string

    Name of the organization.

  • users object[]

    Array of user objects belonging to the organization.

    Show child properties

    • id number

      Numeric ID of the user.

    • userid string

      User identifier (typically the email address).

    • email string

      Email address of the user.

    • real_email string

      Primary email address of the user.

    • username string

      Username of the user.

    • firstname string

      First name of the user.

    • lastname string

      Last name of the user.

    • friendly_name string

      Display name of the user.

    • avatar string

      URL of the user’s avatar image.

    • org_role string

      Role of the user within the organization (for example, "admin" or "member").

    • sign_in_count number

      Total number of sign-ins for the user.

    • created_at string

      Creation date of the user (Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ).

    • last_sign_in_at string

      Timestamp of the user’s last sign-in.

    • last_sign_in_ip string

      IP address of the user’s last sign-in.

    • disabled boolean

      Indicates whether the user account is disabled.

    • partner_role string

      Partner role of the user, if applicable.

    • on_spaces number[]

      Array of space IDs the user has access to.

    • roles_on_spaces object

      Object mapping space IDs to arrays of role names.

  • spaces object[]

    Array of space objects belonging to the organization.

  • settings object

    Organization settings.

  • plan string

    Name of the organization’s pricing plan (for example, "starter").

  • plan_level number

    Numeric level of the organization’s pricing plan.

  • user_count number

    Total number of users in the organization.

  • max_spaces number

    Maximum number of spaces allowed for the organization.

  • max_collaborators number

    Maximum number of collaborators allowed for the organization.

  • billing_address object

    Billing information for the organization.

  • invitations object[]

    Array of pending invitation objects.

    Show child properties

    • id number

      Numeric ID of the invitation.

    • email string

      Email address of the invitee.

    • org_id number

      Numeric ID of the organization.

    • user_id number

      Numeric ID of the inviting user.

    • expires_at string

      Expiration date of the invitation (Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ).

    • org_role string

      Role assigned to the invitee (for example, "admin" or "member").

    • inviter_id number

      Numeric ID of the user who sent the invitation.

    • registered boolean

      Indicates whether the invitee has registered.

  • external_users object[]

    Array of external user objects.

  • extended_external_users object[]

    Array of extended external user objects.

  • track_statistics boolean

    Indicates whether statistics tracking is enabled.

  • sso_firstname string

    SSO first name mapping, if configured.

  • sso_lastname string

    SSO last name mapping, if configured.

  • sso_alt_email string

    SSO alternative email mapping, if configured.

  • strong_auth string

    Strong authentication configuration, if enabled.

  • restricted_regions string[]

    Array of restricted region codes for the organization.

Examples

cURL

curl "https://mapi.storyblok.com/v1/orgs/me" \
  -H "Authorization: YOUR_OAUTH_TOKEN"

JS

// storyblok-js-client@>=7, node@>=18
import Storyblok from "storyblok-js-client";

const storyblok = new Storyblok({
  oauthToken: "YOUR_PERSONAL_ACCESS_TOKEN",
});

try {
  const response = await storyblok.get('orgs/me', {})
  console.log({ response })
} catch (error) {
  console.log(error)
}

PHP

$client = new \Storyblok\ManagementClient('YOUR_OAUTH_TOKEN');

$client->get('orgs/me')->getBody();

Java

HttpResponse<String> response = Unirest.get("https://mapi.storyblok.com/v1/orgs/me")
  .header("Authorization", "YOUR_OAUTH_TOKEN")
  .asString();

C#

var client = new RestClient("https://mapi.storyblok.com/v1/orgs/me");
var request = new RestRequest(Method.GET);

request.AddHeader("Authorization", "YOUR_OAUTH_TOKEN");
IRestResponse response = client.Execute(request);

Python

import requests

url = "https://mapi.storyblok.com/v1/orgs/me"

querystring = {}

payload = ""
headers = {
  'Authorization': "YOUR_OAUTH_TOKEN"
}

response = requests.request("GET", url, data=payload, headers=headers, params=querystring)

print(response.text)

Ruby

require 'storyblok'
client = Storyblok::Client.new(oauth_token: 'YOUR_OAUTH_TOKEN')

client.get('orgs/me')

Swift

let storyblok = URLSession(storyblok: .mapi(accessToken: .oauth("YOUR_OAUTH_TOKEN")))
let request = URLRequest(storyblok: storyblok, path: "orgs/me")
let (data, _) = try await storyblok.data(for: request)
print(try JSONSerialization.jsonObject(with: data))

Kotlin

val client = HttpClient {
    install(Storyblok(MAPI)) {
        accessToken = OAuth("YOUR_OAUTH_TOKEN")
    }
}

val response = client.get("orgs/me")

println(response.body<JsonElement>())