---
title: "List business units"
method: GET
path: "/business-units"
tags: ["Business Units"]
---

# List business units

`GET /business-units`

## Request

- Base URL: `https://www.ruddr.io/api/workspace`
- URL: `https://www.ruddr.io/api/workspace/business-units`
- Auth: HTTP bearer

## Query parameters

- `startingAfter` string
- `endingBefore` string
- `limit` integer
- `name` string

## Response `200`

200

- object
  - `results` BusinessUnit[]: The list of results for the current page.
    - `id` string: The unique identifier for the object.
    - `name` string: The name of the business unit.
    - `isActive` boolean: Whether the business unit is active.
    - `companyName` string, nullable: The company name displayed on invoices for this business unit.
    - `streetAddress` string, nullable: The street address displayed on invoices for this business unit.
    - `invoiceSubject` string, nullable: The default subject line for invoices.
    - `invoiceNotes` string, nullable: The default notes for invoices.
    - `invoiceEmailSubject` string, nullable: The default email subject when sending invoices.
    - `invoiceEmailBody` string, nullable: The default email body when sending invoices.
    - `invoiceEmailFromName` string, nullable: The sender name used when emailing invoices.
    - `invoiceEmailReplyTo` string, nullable: The reply-to email address used when emailing invoices.
    - `invoiceTaxableItems` string[]: The types of invoice line items that are taxable.
    - `createdAt` string, date-time: The timestamp when the object was created.
    - `invoicePaymentTerm` object, nullable: The default payment term for invoices.
      - `id` string: The unique identifier for the object.
      - `name` string: The name of the payment term.
      - `type` string: The type of payment term.
      - `days` integer: The number of days for the payment term.
    - `invoiceTaxRate` object, nullable: The default tax rate for invoices.
      - `id` string: The unique identifier for the object.
      - `name` string: The name of the tax rate.
      - `rate` number: The tax rate percentage.
  - `hasMore` boolean: Whether there are more results available after this page.

## Other responses

- `400`: 400
- `403`: 403

---

[API](https://skmtc.dev/ruddr/apis/ruddr-api.md) · [All operations](https://skmtc.dev/ruddr/apis/ruddr-api/llms.txt) · [OpenAPI document](https://skmtc.dev/ruddr/apis/ruddr-api/revisions/01c3f2a969ba?raw)