Atlas
Admin — Organizations

Get organization details

Returns full organization details including members and pending invitations.

GET
/api/v1/admin/organizations/{id}

Path Parameters

id*string
Length1 <= length <= 128

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:3001/api/v1/admin/organizations/org_abc123"
{
  "organization": {
    "id": "string",
    "name": "string",
    "slug": "string",
    "logo": "string",
    "metadata": {
      "property1": null,
      "property2": null
    },
    "createdAt": "string",
    "workspaceStatus": "string",
    "planTier": "string",
    "suspendedAt": "string",
    "deletedAt": "string"
  },
  "members": [
    {
      "id": "string",
      "organizationId": "string",
      "userId": "string",
      "role": "string",
      "createdAt": "string",
      "user": {
        "id": "string",
        "name": "string",
        "email": "string",
        "image": "string"
      }
    }
  ],
  "invitations": [
    {
      "id": "string",
      "email": "string",
      "role": "string",
      "status": "string",
      "inviterId": "string",
      "expiresAt": "string",
      "createdAt": "string"
    }
  ]
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
{
  "property1": null,
  "property2": null
}
{
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
{
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
Edit on GitHub

Last updated on