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>'
Returns details for a single organization by its numeric ID, including known aliases. Use the optional include parameter to embed recent radar and/or signal events in the same response — useful for building an organization profile page in a single call.

​
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": "Organization Name",
    "aliases": ["Alias1", "Alias2"]
  }
}

​
Response with include (200)

{
  "data": {
    "id": 526,
    "label": "Organization Name",
    "aliases": ["Alias1", "Alias2"]
  },
  "radar": [
    {
      "id": 650,
      "title": "Event Title",
      "signal": 7.01
    }
  ],
  "signal": [
    {
      "id": 707,
      "title": "Signal Event Title",
      "signal": 12.45
    }
  ]
}

​
Errors

  • 400 if id missing
  • 500 on internal server error