Skip to main content
GET
/
v1
/
organizations
/
byOrganizationId
Get Organization by ID
curl --request GET \
  --url https://api.shoal.xyz/v1/organizations/byOrganizationId \
  --header 'Authorization: Bearer <token>'

Documentation Index

Fetch the complete documentation index at: https://docs.shoal.xyz/llms.txt

Use this file to discover all available pages before exploring further.

Returns details for a single canonical organization by numeric ID. Use the optional include parameter to embed recent radar and/or signal events in the same response. When embedded radar or signal data is requested, Shoal prioritizes direct organization matches first and may also include strongly related context when it is clearly relevant.

​
Query Parameters

  • id (integer, required)
  • include (string, optional) - Comma-separated list: radar, signal. Embeds recent events in the response.
  • includeLimit (integer, optional, default: 5, max: 20) - Number of embedded events per type.

​
Request

cURL
curl -X GET "https://api.shoal.xyz/v1/organizations/byOrganizationId?id=526" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Request with include

cURL
curl -X GET "https://api.shoal.xyz/v1/organizations/byOrganizationId?id=526&include=radar,signal&includeLimit=3" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Response (200)

{
  "data": {
    "id": 526,
    "label": "Ethereum",
    "aliases": ["ETH", "Ethereum Foundation"]
  }
}
aliases is a small public hint set, not a full alias inventory.

​
Response with include (200)

{
  "data": {
    "id": 526,
    "label": "Ethereum",
    "aliases": ["ETH", "Ethereum Foundation"]
  },
  "radar": [
    {
      "id": 650,
      "title": "Event Title",
      "signal": 7.01
    }
  ],
  "signal": [
    {
      "id": 707,
      "title": "Signal Event Title",
      "signal": 12.45
    }
  ]
}

​
Notes

  • Organization IDs represent canonical organization profiles.
  • Aliases resolve to the same canonical profile.
  • Embedded radar and signal results may include closely related organization or asset context when it is strongly relevant to the requested organization.

​
Errors

  • 400 if id missing
  • 500 on internal server error