Skip to main content
Upcoming Mid April 2026

​
List My Organizations

Returns a paginated list of organizations the authenticated user belongs to.

​
GET /identity/memberships/my/organizations

​
Query Parameters

​
page
integer
default:"1"
Page number.
​
limit
integer
default:"50"
Results per page.
​
sortOrder
string
default:"ASC"
Sort order. ASC or DESC.
​
sortBy
string
default:"createdAt"
Field to sort by.
cURL
curl "https://api-staging.internal-aui.io/api/outer-bridge/identity/memberships/my/organizations?page=1&limit=50&sortOrder=ASC&sortBy=createdAt" \
  -H "auth-token: your-jwt-token" \
  -H "x-aui-client: AUI" \
  -H "x-aui-environment: staging" \
  -H "x-aui-origin: stores"

{
  "status": true,
  "data": {
    "docs": [
      {
        "_id": "string",
        "id": "string",
        "name": "string",
        "niceName": "string",
        "status": "ACTIVE",
        "createdAt": "string",
        "updatedAt": "string"
      }
    ],
    "totalDocs": 10,
    "limit": 50,
    "totalPages": 1,
    "page": 1,
    "hasPrevPage": false,
    "hasNextPage": false,
    "prevPage": null,
    "nextPage": null
  },
  "message": "string"
}

​
Best Practices

  • Cache the organization list — Organization memberships change infrequently. Cache the response locally and refresh only on login or when the user explicitly switches contexts.
  • Use hasNextPage for pagination — Don’t assume a fixed page count. Use the hasNextPage flag to determine whether to fetch more results.
  • Filter by status: ACTIVE — The response may include inactive organizations. Filter client-side or let the user choose only from active ones.

​
Get Organization

Retrieve a single organization by ID.

​
GET /network/v1/organization/{orgId}

​
Path Parameters

​
orgId
string
required
The organization ID.
cURL
curl "https://api-staging.internal-aui.io/api/outer-bridge/network/v1/organization/org-id-here" \
  -H "auth-token: your-jwt-token" \
  -H "account-id: your-account-id" \
  -H "organization-id: your-org-id" \
  -H "x-aui-client: AUI" \
  -H "x-aui-environment: staging" \
  -H "x-aui-origin: stores"

{
  "status": true,
  "data": {
    "_id": "string",
    "id": "string",
    "name": "string",
    "niceName": "string",
    "status": "ACTIVE",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

​
Best Practices

  • Use to validate org context — Call this after switching organizations to confirm the org exists and is active before making further requests.
  • Store niceName for display — Use niceName (human-readable) in UI, and _id or id for API calls.