---
title: "Get brood by ID"
method: GET
path: "/broods/view/{broodId}"
tags: ["Broods"]
---

# Get brood by ID

`GET /broods/view/{broodId}`

## Request

- Base URL: `https://cerebrate.local`
- URL: `https://cerebrate.local/broods/view/{broodId}`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/cerebrate-project/apis/cerebrate-project-api/docs/broods/view/:broodId/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `broodId` integer, required

## Response `200`

Brood response

- Brood
  - `id` integer
  - `uuid` string, uuid
  - `name` string
  - `url` string
  - `description` string
  - `organisation_id` integer
  - `trusted` boolean: Trusted upstream source
  - `pull` boolean: Enable pulling of trust information
  - `skip_proxy` boolean
  - `authkey` string
  - `organisation` Organisation
    - `id` integer
    - `uuid` string, uuid
    - `name` string
    - `url` string
    - `nationality` string, nullable
    - `sector` string, nullable
    - `type` string, nullable
    - `contacts` string, nullable
    - `created` string, datetime
    - `modified` string, datetime
    - `tags` Tag[]
      - `id` integer
      - `name` string
      - `namespace` string, nullable
      - `predicate` string, nullable
      - `value` string, nullable
      - `colour` string
      - `text_colour` string
      - `counter` integer
      - `created` string, datetime
      - `modified` string, datetime
    - `aligments` Alignment[]
  - `created` string, datetime
  - `modified` string, datetime

## Other responses

- `403`: Authentication failed. Please make sure you pass the API key of an API enabled user along in the Authorization header.
- `405`: Method not allowed. Your User Role is not allowed to access this resource.
- `default`: Unexpected API error

## Changes

- **2022-01-19** `6cbe42203ac4`: 1 info
  - endpoint added
- **2022-01-07** `75b84299e5fa`: 1 breaking
  - api path removed without deprecation

[Operation history](https://skmtc.dev/cerebrate-project/apis/cerebrate-project-api/changes/broods/view/:broodId/get.md)

---

[API](https://skmtc.dev/cerebrate-project/apis/cerebrate-project-api.md) - [All operations](https://skmtc.dev/cerebrate-project/apis/cerebrate-project-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cerebrate-project/apis/cerebrate-project-api/revisions/50eb2c1b04b4?raw)