Get an organization

Read organization detail and membership

GET / v1 / organizations / {id}

Read an organization the caller is a member of, including its members and plan limits.

Path parameters

id string required

Responses

Organization detail.

organization object required

members object[] required

Members of the organization. Only returned to callers who are themselves members (the handler enforces membership and returns 404 otherwise — non-members never see this list).

plan object required

role string required

Available options: owner, admin, editor, viewer, billing

curl --request GET \
  --url "https://api.squirrelscan.com/v1/organizations/ID"

const res = await fetch("https://api.squirrelscan.com/v1/organizations/ID", {
  method: "GET",
});
const data = await res.json();

import requests


r = requests.get("https://api.squirrelscan.com/v1/organizations/ID")
r.raise_for_status()
data = r.json()

{
  "organization": {
    "id": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "planId": "<string>",
    "createdAt": {},
    "updatedAt": {}
  },
  "members": [],
  "plan": {
    "id": "<string>",
    "name": "<string>",
    "maxMembers": 123,
    "monthlyCredits": 123,
    "signupGrantCredits": 123
  },
  "role": "owner"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

Edit this page