The HCB API

https://hcb.hackclub.com/docs/api/v3
Admin
The HCB API is an unauthenticated REST API that allows users to read public information from...
Tokens:8,171
Snippets:45
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Tag Schema Example

Source: https://hcb.hackclub.com/docs/api/v3/schemas/Tag

This is an example of the Tag object schema. It includes fields for id, object type, and a label.

```json
{
  "id": "string",
  "object": "string",
  "label": "string"
}
```

--------------------------------

### Card Model Example

Source: https://hcb.hackclub.com/docs/api/v3/schemas/Card

This is an example of the Card model as returned by the HCB API. It includes details about the card itself, its owner, and the organization it belongs to.

```json
{
  "id": "string",
  "object": "string",
  "href": "string",
  "name": "string",
  "type": "virtual",
  "status": "active",
  "issued_at": "string",
  "owner": {
    "id": "string",
    "object": "string",
    "full_name": "string",
    "auditor": true,
    "admin": true,
    "photo": "string"
  },
  "organization": {
    "id": "string",
    "object": "string",
    "href": "string",
    "name": "string",
    "slug": "string",
    "website": "string",
    "category": "hack_club_hq",
    "transparent": true,
    "demo_mode": true,
    "financially_frozen": true,
    "logo": "string",
    "donation_header": "string",
    "background_image": "string",
    "public_message": "string",
    "donation_link": "string",
    "balances": {
      "balance_cents": 0,
      "fee_balance_cents": 0,
      "incoming_balance_cents": 0,
      "total_raised": 0
    },
    "created_at": "string",
    "users": [
      {}
    ]
  }
}
```

--------------------------------

### API Error Example

Source: https://hcb.hackclub.com/docs/api/v3/schemas/Invoice

Illustrates a potential error response from the API, specifically a RangeError indicating a maximum call stack size has been exceeded.

```text
1
Example cannot be created for this schema
2
RangeError: Maximum call stack size exceeded
```

--------------------------------

### Organization Model Example

Source: https://hcb.hackclub.com/docs/api/v3/schemas/Organization

This JSON object represents a typical organization within the HCB API. It includes details about the organization's identity, financial status, and associated users. Ensure all required fields are present when creating or updating an organization.

```json
{
  "id": "string",
  "object": "string",
  "href": "string",
  "name": "string",
  "slug": "string",
  "website": "string",
  "category": "hack_club_hq",
  "transparent": true,
  "demo_mode": true,
  "financially_frozen": true,
  "logo": "string",
  "donation_header": "string",
  "background_image": "string",
  "public_message": "string",
  "donation_link": "string",
  "balances": {
    "balance_cents": 0,
    "fee_balance_cents": 0,
    "incoming_balance_cents": 0,
    "total_raised": 0
  },
  "created_at": "string",
  "users": [
    {
      "id": "string",
      "object": "string",
      "full_name": "string",
      "auditor": true,
      "admin": true,
      "photo": "string"
    }
  ]
}
```

--------------------------------

### HCB API Overview

Source: https://hcb.hackclub.com/docs/api/v3/schemas/Check%20Deposit

General information regarding the HCB API v3, including access scope and support channels.

```APIDOC
## HCB API v3.0.0

### Description
The HCB API is an unauthenticated REST API that allows you to read public information from organizations with Transparency Mode enabled.

### Support
- **Slack**: #hcb channel on the Hack Club Slack
- **Email**: hcb@hackclub.com
```

--------------------------------

### HCB API Overview

Source: https://hcb.hackclub.com/docs/api/v3/schemas/Card%20Charge

General information regarding the HCB API v3.0.0, including access scope and support channels.

```APIDOC
## HCB API Overview

### Description
The HCB API is an unauthenticated REST API that allows you to read public information from organizations with Transparency Mode enabled.

### Version
3.0.0

### Support
For questions or suggestions, reach out in the #hcb channel on the Hack Club Slack or email hcb@hackclub.com.
```

--------------------------------

### Available Schemas

Source: https://hcb.hackclub.com/docs/api/v3/schemas/Wise%20Transfer

A list of available data schemas in the HCB API.

```APIDOC
## Available Schemas

### Description
The HCB API defines the following data schemas:

### Schemas
- Organization
- User
- Transaction
- Tag
- Card Charge
- Card
- ACH Transfer
- Check
- Donation
- Invoice
- Transfer
- Wire Transfer
- Wise Transfer
- Check Deposit
- Reimbursed Expense
- HCB Fee
- Activity
- Error Response
```

--------------------------------

### Available Endpoints

Source: https://hcb.hackclub.com/docs/api/v3/schemas/HCB%20Fee

A list of available endpoints for interacting with the HCB API.

```APIDOC
## Available Endpoints

### Organizations
- GET /organizations
- GET /organizations/{id}

### Transactions
- GET /transactions
- GET /transactions/{id}

### Card Charges
- GET /card_charges
- GET /card_charges/{id}

### Donations
- GET /donations
- GET /donations/{id}

### Invoices
- GET /invoices
- GET /invoices/{id}

### Checks
- GET /checks
- GET /checks/{id}

### ACH Transfers
- GET /ach_transfers
- GET /ach_transfers/{id}

### Transfers
- GET /transfers
- GET /transfers/{id}

### Wire Transfers
- GET /wire_transfers
- GET /wire_transfers/{id}

### Wise Transfers
- GET /wise_transfers
- GET /wise_transfers/{id}

### Check Deposits
- GET /check_deposits
- GET /check_deposits/{id}

### Reimbursed Expenses
- GET /reimbursed_expenses
- GET /reimbursed_expenses/{id}

### HCB Fees
- GET /hcb_fees
- GET /hcb_fees/{id}

### Cards
- GET /cards
- GET /cards/{id}

### Activities
- GET /activities
- GET /activities/{id}
```

--------------------------------

### Available Endpoints

Source: https://hcb.hackclub.com/docs/api/v3/schemas/Wise%20Transfer

A list of available endpoints in the HCB API.

```APIDOC
## Available Endpoints

### Description
The HCB API provides access to the following resources:

### Endpoints
- Organizations
- Transactions
- Card Charges
- Donations
- Invoices
- Checks
- ACH Transfers
- Transfers
- Wire Transfers
- Wise Transfers
- Check Deposits
- Reimbursed Expenses
- HCB Fees
- Cards
- Activities
```

--------------------------------

### User Object Schema

Source: https://hcb.hackclub.com/docs/api/v3/schemas/User

Represents a user within the HCB system. Includes fields for ID, full name, and administrative/auditor roles.

```json
{
  "id": "string",
  "object": "string",
  "full_name": "string",
  "auditor": true,
  "admin": true,
  "photo": "string"
}
```

--------------------------------

### Schemas

Source: https://hcb.hackclub.com/docs/api/v3/schemas/HCB%20Fee

Defines the structure of various data objects available through the API.

```APIDOC
## Schemas

### Organization
Represents an organization.

### User
Represents a user.

### Transaction
Represents a financial transaction.

### Tag
Represents a tag.

### Card Charge
Represents a card charge.

### Card
Represents a card.

### ACH Transfer
Represents an ACH transfer.

### Check
Represents a check.

### Donation
Represents a donation.

### Invoice
Represents an invoice.

### Transfer
Represents a transfer.

### Wire Transfer
Represents a wire transfer.

### Wise Transfer
Represents a Wise transfer.

### Check Deposit
Represents a check deposit.

### Reimbursed Expense
Represents a reimbursed expense.

### HCB Fee
Represents an HCB fee.

### Activity
Represents an activity.
```

--------------------------------

### Organization Model

Source: https://hcb.hackclub.com/docs/api/v3/schemas/Organization

Details the structure and fields of the Organization object within the HCB API.

```APIDOC
## Organization Model

### Description
Represents an organization within the HCB system, including its financial details and associated users.

### Fields
- **id** (string) - Required - Unique identifier for the organization.
- **object** (string) - Required - Type of the object, typically 'organization'.
- **href** (string) - Required - URL to access the organization resource.
- **name** (string) - The name of the organization.
- **slug** (string) - A URL-friendly version of the organization's name.
- **website** (string) - The organization's website URL.
- **category** (string) - Allowed values: `hack_club`, `hq`, `robotics_team`, `hackathon`, `climate`, `nonprofit`, `transparent`. The category of the organization.
- **transparent** (boolean) - Indicates if the organization is transparent.
- **demo_mode** (boolean) - Indicates if the organization is in demo mode.
- **financially_frozen** (boolean) - Indicates if the organization's finances are frozen.
- **logo** (string) - URL to the organization's logo.
- **donation_header** (string) - Header text for donations.
- **background_image** (string) - URL to the organization's background image.
- **public_message** (string) - A public message from the organization.
- **donation_link** (string) - URL for donations.
- **balances** (object) - Financial balances of the organization.
  - **balance_cents** (integer) - The current balance in cents.
  - **fee_balance_cents** (integer) - The balance of fees in cents.
  - **incoming_balance_cents** (integer) - The incoming balance in cents.
  - **total_raised** (integer) - The total amount raised.
- **created_at** (string) - The timestamp when the organization was created.
- **users** (array[object]) - A list of users associated with the organization.
  - **id** (string) - Required - Unique identifier for the user.
  - **object** (string) - Required - Type of the object, typically 'user'.
  - **full_name** (string) - Required - The full name of the user.
  - **auditor** (boolean) - Required - Indicates if the user is an auditor.
  - **admin** (boolean) - Required - Indicates if the user is an administrator.
  - **photo** (string) - Required - URL to the user's photo.

### Example
```json
{
  "id": "string",
  "object": "string",
  "href": "string",
  "name": "string",
  "slug": "string",
  "website": "string",
  "category": "hack_club_hq",
  "transparent": true,
  "demo_mode": true,
  "financially_frozen": true,
  "logo": "string",
  "donation_header": "string",
  "background_image": "string",
  "public_message": "string",
  "donation_link": "string",
  "balances": {
    "balance_cents": 0,
    "fee_balance_cents": 0,
    "incoming_balance_cents": 0,
    "total_raised": 0
  },
  "created_at": "string",
  "users": [
    {
      "id": "string",
      "object": "string",
      "full_name": "string",
      "auditor": true,
      "admin": true,
      "photo": "string"
    }
  ]
}
```
```

--------------------------------

### User Schema

Source: https://hcb.hackclub.com/docs/api/v3/schemas/User

Defines the structure of the User object within the HCB API.

```APIDOC
## User Schema

### Description
Represents a user within the HCB system.

### Parameters
- **id** (string) - Required - Unique identifier for the user.
- **object** (string) - Required - The type of object.
- **full_name** (string) - Required - The full name of the user.
- **auditor** (boolean) - Required - Indicates if the user has auditor permissions.
- **admin** (boolean) - Required - Indicates if the user has admin permissions.
- **photo** (string) - Required - URL to the user's photo.

### Response Example
{
  "id": "string",
  "object": "string",
  "full_name": "string",
  "auditor": true,
  "admin": true,
  "photo": "string"
}
```

--------------------------------

### Transfer Model

Source: https://hcb.hackclub.com/docs/api/v3/schemas/Transfer

The Transfer model defines the structure for financial transfers. It includes details such as ID, amount, memo, and associated transaction information.

```APIDOC
## Transfer Model

### Description
Represents a financial transfer within the HCB system.

### Fields
- **id** (string) - required - Unique identifier for the transfer.
- **href** (string) - required - URL reference to the transfer resource.
- **memo** (string) - optional - A note or description for the transfer.
- **transaction** (object) - required - Associated transaction details.
  - **id** (string) - required - Unique identifier for the transaction.
  - **href** (string) - required - URL reference to the transaction resource.
  - **amount_cents** (integer) - required - The amount of the transfer in cents.
  - **memo** (string) - optional - A note or description for the transaction.
  - **date** (string) - required - The date of the transaction.
  - **type** (string) - required - The type of transaction. Allowed values: `invoicedonationach_transferchecktransferbank_account_transactioncard_chargewire_transferwise_transfercheck_depositreimbursed_expensehcb_fee`.
  - **pending** (boolean) - required - Indicates if the transaction is pending.
  - **receipts** (object) - optional - Information about receipts.
  - **comments** (object) - optional - Comments related to the transaction.
  - **organization** (object) - required - The organization associated with the transaction.
    - **id** (string) - required - Unique identifier for the organization.
    - **href** (string) - required - URL reference to the organization resource.
  - **user** (object) - optional - The user associated with the transaction.
  - **tags** (array[object]) - optional - Tags associated with the transaction.
  - **card_charge** (object) - optional - Details of a card charge if applicable.
  - **ach_transfer** (object) - optional - Details of an ACH transfer if applicable.
  - **check** (object) - optional - Details of a check if applicable.
  - **donation** (object) - optional - Details of a donation if applicable.
  - **invoice** (object) - optional - Details of an invoice if applicable.
  - **transfer** (object) - optional - Details of a related transfer if applicable.
  - **wire_transfer** (object) - optional - Details of a wire transfer if applicable.
  - **wise_transfer** (object) - optional - Details of a Wise transfer if applicable.
  - **check_deposit** (object) - optional - Details of a check deposit if applicable.
  - **reimbursed_expense** (object) - optional - Details of a reimbursed expense if applicable.
  - **hcb_fee** (object) - optional - Details of an HCB fee if applicable.
- **source_organization** (object) - optional - The organization from which the transfer originated.
  - **id** (string) - required - Unique identifier for the organization.
  - **href** (string) - required - URL reference to the organization resource.
- **amount_cents** (string) - required - The amount of the transfer in cents.
- **date** (string) - required - The date of the transfer.
- **status** (string) - required - The status of the transfer. Allowed values: `fulfilledprocessingrejectedcancelederroredunder_reviewpending`.
```

--------------------------------

### Invoice Model Schema

Source: https://hcb.hackclub.com/docs/api/v3/schemas/Invoice

Defines the structure of an Invoice object, including its unique identifier, amount in cents, memo, and links to related Transaction and Organization objects.

```json
{
  "id": "string (required)",
  "href": "string (required)",
  "memo": "string",
  "transaction": {
    "id": "string (required)",
    "href": "string (required)",
    "amount_cents": "integer<int32>",
    "memo": "string",
    "date": "string",
    "type": "string (allowed values: invoicedonationach_transferchecktransferbank_account_transactioncard_chargewire_transferwise_transfercheck_depositreimbursed_expensehcb_fee)",
    "pending": "boolean",
    "receipts": "object",
    "comments": "object",
    "organization": {
      "id": "string (required)",
      "name": "string"
    },
    "user": {
      "id": "string (required)",
      "href": "string (required)"
    },
    "tags": [
      "object"
    ],
    "card_charge": {
      "id": "string (required)",
      "href": "string (required)"
    },
    "ach_transfer": {
      "id": "string (required)",
      "href": "string (required)"
    },
    "check": {
      "id": "string (required)",
      "href": "string (required)"
    },
    "donation": {
      "id": "string (required)",
      "href": "string (required)"
    },
    "invoice": {
      "id": "string (required)",
      "href": "string (required)"
    },
    "transfer": {
      "id": "string (required)",
      "href": "string (required)"
    },
    "wire_transfer": {
      "id": "string (required)",
      "href": "string (required)"
    },
    "wise_transfer": {
      "id": "string (required)",
      "href": "string (required)"
    },
    "check_deposit": {
      "id": "string (required)",
      "href": "string (required)"
    },
    "reimbursed_expense": {
      "id": "string (required)",
      "href": "string (required)"
    },
    "hcb_fee": {
      "id": "string (required)",
      "href": "string (required)"
    },
    "organization": {
      "id": "string (required)",
      "name": "string"
    }
  },
  "organization": {
    "id": "string (required)",
    "name": "string"
  },
  "amount_cents": "string",
  "sponsor": {
    "id": "string",
    "name": "string"
  },
  "date": "string",
  "status": "string (allowed values: openpaidvoid)"
}
```

--------------------------------

### HCB API Schemas

Source: https://hcb.hackclub.com/docs/api/v3

Data schemas available in the HCB API.

```APIDOC
## HCB API Schemas

### Available Schemas
- Organization
- User
- Transaction
- Tag
- Card Charge
- Card
- ACH Transfer
- Check
- Donation
- Invoice
- Transfer
- Wire Transfer
- Wise Transfer
- Check Deposit
- Reimbursed Expense
- HCB Fee
- Activity
- Error Response
```

--------------------------------

### HCB API Endpoints

Source: https://hcb.hackclub.com/docs/api/v3

Available endpoints for interacting with the HCB API.

```APIDOC
## HCB API Endpoints

### Available Endpoints
- Organizations
- Transactions
- Card Charges
- Donations
- Invoices
- Checks
- ACH Transfers
- Transfers
- Wire Transfers
- Wise Transfers
- Check Deposits
- Reimbursed Expenses
- HCB Fees
- Cards
- Activities
```

--------------------------------

### HCB API Endpoints

Source: https://hcb.hackclub.com/docs/api/v3/schemas/Reimbursed%20Expense

Available endpoints for interacting with the HCB API.

```APIDOC
## HCB API Endpoints

### Organizations
- **GET /organizations** - Retrieve a list of organizations.
- **GET /organizations/{id}** - Retrieve a specific organization by ID.

### Transactions
- **GET /transactions** - Retrieve a list of transactions.
- **GET /transactions/{id}** - Retrieve a specific transaction by ID.

### Card Charges
- **GET /card_charges** - Retrieve a list of card charges.
- **GET /card_charges/{id}** - Retrieve a specific card charge by ID.

### Donations
- **GET /donations** - Retrieve a list of donations.
- **GET /donations/{id}** - Retrieve a specific donation by ID.

### Invoices
- **GET /invoices** - Retrieve a list of invoices.
- **GET /invoices/{id}** - Retrieve a specific invoice by ID.

### Checks
- **GET /checks** - Retrieve a list of checks.
- **GET /checks/{id}** - Retrieve a specific check by ID.

### ACH Transfers
- **GET /ach_transfers** - Retrieve a list of ACH transfers.
- **GET /ach_transfers/{id}** - Retrieve a specific ACH transfer by ID.

### Transfers
- **GET /transfers** - Retrieve a list of transfers.
- **GET /transfers/{id}** - Retrieve a specific transfer by ID.

### Wire Transfers
- **GET /wire_transfers** - Retrieve a list of wire transfers.
- **GET /wire_transfers/{id}** - Retrieve a specific wire transfer by ID.

### Wise Transfers
- **GET /wise_transfers** - Retrieve a list of Wise transfers.
- **GET /wise_transfers/{id}** - Retrieve a specific Wise transfer by ID.

### Check Deposits
- **GET /check_deposits** - Retrieve a list of check deposits.
- **GET /check_deposits/{id}** - Retrieve a specific check deposit by ID.

### Reimbursed Expenses
- **GET /reimbursed_expenses** - Retrieve a list of reimbursed expenses.
- **GET /reimbursed_expenses/{id}** - Retrieve a specific reimbursed expense by ID.

### HCB Fees
- **GET /hcb_fees** - Retrieve a list of HCB fees.
- **GET /hcb_fees/{id}** - Retrieve a specific HCB fee by ID.

### Cards
- **GET /cards** - Retrieve a list of cards.
- **GET /cards/{id}** - Retrieve a specific card by ID.

### Activities
- **GET /activities** - Retrieve a list of activities.
- **GET /activities/{id}** - Retrieve a specific activity by ID.
```

--------------------------------

### Check Model Schema

Source: https://hcb.hackclub.com/docs/api/v3/schemas/Check

Defines the fields available for a Check object within the HCB API.

```APIDOC
## Check Model

### Description
Represents a check transaction within the HCB system.

### Fields
- **id** (string) - Required - Unique identifier for the check.
- **href** (string) - Required - URL to access the check resource.
- **memo** (string) - Optional - A descriptive note for the check.
- **transaction** (object) - Required - Associated Transaction model.
  - **id** (string) - Required - Unique identifier for the transaction.
  - **href** (string) - Required - URL to access the transaction resource.
  - **amount_cents** (integer) - Required - The transaction amount in cents.
  - **memo** (string) - Optional - A descriptive note for the transaction.
  - **date** (string) - Required - The date of the transaction.
  - **type** (string) - Required - The type of transaction. Allowed values: `invoicedonationach_transferchecktransferbank_account_transactioncard_chargewire_transferwise_transfercheck_depositreimbursed_expensehcb_fee`.
  - **pending** (boolean) - Required - Indicates if the transaction is pending.
  - **receipts** (object) - Optional - Associated receipts.
  - **comments** (object) - Optional - Associated comments.
  - **organization** (object) - Required - Associated Organization model.
    - **id** (string) - Required - Unique identifier for the organization.
    - **href** (string) - Required - URL to access the organization resource.
  - **user** (object) - Required - Associated User model.
  - **tags** (array[object]) - Optional - Associated tags.
  - **card_charge** (object) - Optional - Associated Card Charge model.
  - **ach_transfer** (object) - Optional - Associated ACH Transfer model.
  - **check** (object) - Optional - Associated Check model.
  - **donation** (object) - Optional - Associated Donation model.
  - **invoice** (object) - Optional - Associated Invoice model.
  - **transfer** (object) - Optional - Associated Transfer model.
  - **wire_transfer** (object) - Optional - Associated Wire Transfer model.
  - **wise_transfer** (object) - Optional - Associated Wise Transfer model.
  - **check_deposit** (object) - Optional - Associated Check Deposit model.
  - **reimbursed_expense** (object) - Optional - Associated Reimbursed Expense model.
  - **hcb_fee** (object) - Optional - Associated HCB Fee model.
  - **organization** (object) - Required - Associated Organization model.
    - **amount_cents** (integer) - Required - The amount in cents.
    - **date** (string) - Required - The date of the record.
    - **status** (string) - Required - The status of the record. Allowed values: `scheduledin_transitin_transit_and_processeddepositedcanceledvoidedrefunded`.
```

--------------------------------

### Card Model Schema

Source: https://hcb.hackclub.com/docs/api/v3/schemas/Card

The Card model represents a virtual or physical card issued within the HCB platform, containing information about the card status, owner, and associated organization.

```APIDOC
## Card Model

### Description
The Card model represents a payment card (virtual or physical) associated with an organization and an owner.

### Fields
- **id** (string) - Required - Unique identifier for the card.
- **object** (string) - Required - The type of object (e.g., "card").
- **href** (string) - Required - API resource link.
- **name** (string) - Optional - Name assigned to the card.
- **type** (string) - Optional - Type of card: "virtual" or "physical".
- **status** (string) - Optional - Current status: "active", "inactive", "frozen", or "canceled".
- **issued_at** (string) - Optional - Timestamp of issuance.
- **owner** (object) - Required - The user who owns the card.
- **organization** (object) - Required - The organization the card belongs to.

### Response Example
{
  "id": "string",
  "object": "string",
  "href": "string",
  "name": "string",
  "type": "virtual",
  "status": "active",
  "issued_at": "string",
  "owner": {
    "id": "string",
    "object": "string",
    "full_name": "string",
    "auditor": true,
    "admin": true,
    "photo": "string"
  },
  "organization": {
    "id": "string",
    "object": "string",
    "href": "string",
    "name": "string",
    "slug": "string",
    "website": "string",
    "category": "hack_club_hq",
    "transparent": true,
    "demo_mode": true,
    "financially_frozen": true,
    "logo": "string",
    "donation_header": "string",
    "background_image": "string",
    "public_message": "string",
    "donation_link": "string",
    "balances": {
      "balance_cents": 0,
      "fee_balance_cents": 0,
      "incoming_balance_cents": 0,
      "total_raised": 0
    },
    "created_at": "string",
    "users": [
      {}
    ]
  }
}
```

--------------------------------

### Tag Object Schema

Source: https://hcb.hackclub.com/docs/api/v3/schemas/Tag

Defines the structure of a Tag object within the HCB API.

```APIDOC
## Tag Object Schema

### Description
Represents a tag used for categorization or identification.

### Fields
- **id** (string) - Required - Unique identifier for the tag.
- **object** (string) - Required - Type of the object, expected to be "tag".
- **label** (string) - Required - The display name or label of the tag.

### Example
```json
{
  "id": "tag_abc123",
  "object": "tag",
  "label": "Development"
}
```
```

--------------------------------

### HCB API Overview

Source: https://hcb.hackclub.com/docs/api/v3

The HCB API is an unauthenticated REST API that allows you to read public information from organizations with Transparency Mode enabled.

```APIDOC
## HCB API Overview

### Description
The HCB API is an unauthenticated REST API that allows you to read public information from organizations with Transparency Mode enabled.

### Contact
Questions or suggestions can be directed to #hcb channel on Hack Club Slack or email hcb@hackclub.com.
```

--------------------------------

### HCB API Overview

Source: https://hcb.hackclub.com/docs/api/v3/schemas/HCB%20Fee

The HCB API is an unauthenticated REST API that allows you to read public information from organizations with Transparency Mode enabled.

```APIDOC
## HCB API Overview

### Description
The HCB API is an unauthenticated REST API that allows you to read public information from organizations with Transparency Mode enabled.

### Contact
Questions or suggestions can be directed to the #hcb channel on the Hack Club Slack or by emailing hcb@hackclub.com.
```

--------------------------------

### Donation Model

Source: https://hcb.hackclub.com/docs/api/v3/schemas/Donation

The Donation model represents a donation made through the HCB system. It includes details about the donation's ID, associated transaction, amount, and donor information.

```APIDOC
## Donation Model

### Description
Represents a donation made through the HCB system.

### Fields
- **id** (string) - Required - Unique identifier for the donation.
- **href** (string) - Required - URL to the donation resource.
- **memo** (string) - Optional - A memo associated with the donation.
- **transaction** (object) - Required - The associated Transaction model.
  - **id** (string) - Required - Unique identifier for the transaction.
  - **href** (string) - Required - URL to the transaction resource.
  - **amount_cents** (integer<int32>) - The amount of the transaction in cents.
  - **memo** (string) - A memo associated with the transaction.
  - **date** (string) - The date of the transaction.
  - **type** (string) - Allowed values: `invoicedonationach_transferchecktransferbank_account_transactioncard_chargewire_transferwise_transfercheck_depositreimbursed_expensehcb_fee` - The type of transaction.
  - **pending** (boolean) - Indicates if the transaction is pending.
  - **receipts** (object) - Information about transaction receipts.
  - **comments** (object) - Comments related to the transaction.
  - **organization** (object) - The associated Organization model.
    - **id** (string) - Required - Unique identifier for the organization.
    - **href** (string) - Required - URL to the organization resource.
    - **user** (object) - The user associated with the organization.
    - **tags** (array[object]) - Tags associated with the organization.
    - **card_charge** (object) - The associated Card Charge model.
    - **ach_transfer** (object) - The associated ACH Transfer model.
    - **check** (object) - The associated Check model.
    - **donation** (object) - The associated Donation model.
    - **invoice** (object) - The associated Invoice model.
    - **transfer** (object) - The associated Transfer model.
    - **wire_transfer** (object) - The associated Wire Transfer model.
    - **wise_transfer** (object) - The associated Wise Transfer model.
    - **check_deposit** (object) - The associated Check Deposit model.
    - **reimbursed_expense** (object) - The associated Reimbursed Expense model.
    - **hcb_fee** (object) - The associated HCB Fee model.
- **organization** (object) - Required - The organization receiving the donation.
  - **id** (string) - Required - Unique identifier for the organization.
  - **href** (string) - Required - URL to the organization resource.
  - **amount_cents** (integer<int32>) - The amount associated with the organization in cents.
  - **donor** (object) - Information about the donor.
    - **name** (string) - The name of the donor.
    - **anonymous** (boolean) - Indicates if the donation is anonymous.
    - **avatar** (string) - URL to the donor's avatar.
  - **date** (string) - The date of the donation.
  - **status** (string) - Allowed values: `pendingin_transitdepositedfailedrefunded` - The status of the donation.
  - **recurring** (boolean) - Indicates if the donation is recurring.
```
Tokens:
Raw