Get an organization

Read organization detail and membership

GET/v1/organizations/{id}

Read an organization the caller belongs to (an API key reads its own organization), with its plan limits. A signed-in member also gets the member list. An API key gets neither the member list nor the organization's billing fields, and keeps working after the member who made it leaves.

Path parameters

idstringrequired

Responses

Organization detail.

organizationobjectrequired

membersobject[]

Members of the organization. Returned only to a signed-in caller who is a member (others get 404). Omitted for API keys: a key acts for the organization, not as one of its people, and can outlive the member who made it.

planobjectrequired

rolestringrequired

The caller's role in the organization. An API key reports admin; what it may do is set by its scopes.

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>"
  }
}

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

Edit this page