Get organizations for a user

GET /api/users/{userId}/organizations

Get all organizations that the user is a member of. In each organization object, the user's roles in that organization are included in the organizationRoles array.

Path parameters

userId string Required

The unique identifier of the user.

Responses

200 application/json

An array of organizations that the user is a member of.
Hide response attributes Show response attributes object
- tenantId string Required
  
  Maximum length is 21.
- id string Required
  
  Minimum length is 1, maximum length is 21.
- name string Required
  
  Minimum length is 1, maximum length is 128.
- description string | null Required
  
  Maximum length is 256.
- customData object Required
  
  arbitrary
  
  Additional properties are allowed.
- isMfaRequired boolean Required
- branding object Required
  
  Additional properties are allowed.
  
  Hide branding attributes Show branding attributes object
  
  logoUrl string(url)
  
  darkLogoUrl string(url)
  
  favicon string(url)
  
  darkFavicon string(url)
- createdAt number Required
- organizationRoles array[object] Required
  
  Hide organizationRoles attributes Show organizationRoles attributes object
  
  id string Required
  
  name string Required
400

Bad Request
401

Unauthorized
403

Forbidden
404

Not Found

GET /api/users/{userId}/organizations

curl \
 -X GET https://[tenant_id].logto.app/api/users/{userId}/organizations \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

[
  {
    "tenantId": "string",
    "id": "string",
    "name": "string",
    "description": "string",
    "customData": {},
    "isMfaRequired": true,
    "branding": {
      "logoUrl": "string",
      "darkLogoUrl": "string",
      "favicon": "string",
      "darkFavicon": "string"
    },
    "createdAt": 42.0,
    "organizationRoles": [
      {
        "id": "string",
        "name": "string"
      }
    ]
  }
]