> ## Documentation Index > Fetch the complete documentation index at: https://docs.ruddr.io/llms.txt > Use this file to discover all available pages before exploring further. # List business units A named organizational unit used to configure invoice settings and group clients and projects. ## OpenAPI ````yaml openapi.json GET /business-units openapi: 3.1.0 info: title: Ruddr API version: '1.0' license: name: Proprietary url: https://www.ruddr.com/master-subscription-agreement servers: - url: https://www.ruddr.io/api/workspace security: - bearerAuth: [] tags: - name: Allocations description: Manage resource allocations for scheduling team members to projects. - name: Availability Periods description: Manage member availability periods for capacity planning. - name: Business Units description: >- Manage business units for organizing invoice settings and grouping clients and projects. - name: Client Roles description: Manage client roles and their billing terms. - name: Client Tags description: Manage tags for categorizing clients. - name: Clients description: Manage clients and their billing settings. - name: Companies description: Manage companies in the CRM pipeline. - name: Company Spend Tiers description: Manage spend tier classifications for companies. - name: Company Types description: Manage type classifications for companies. - name: Contact Tags description: Manage tags for categorizing contacts. - name: Contacts description: Manage contacts associated with clients, companies, and opportunities. - name: Cost Periods description: Manage member cost rate periods for profitability tracking. - name: Credit Notes description: View credit notes issued against invoices. - name: Disciplines description: Manage disciplines for classifying member skill areas. - name: Exchange Rate description: Get exchange rates for multi-currency workspaces. - name: Exchange Rate Periods description: Manage custom exchange rate periods for currency conversion. - name: Expense Categories description: Manage expense categories for tracking and reporting. - name: Expense Items description: Manage individual expense line items. - name: Expense Reports description: Manage expense reports submitted by members. - name: Holiday Schedules description: Manage holiday schedules for capacity and availability planning. - name: Holidays description: Manage individual holidays within holiday schedules. - name: Industries description: Manage industry classifications for clients and companies. - name: Invoice Items description: Manage invoice line item types for billing. - name: Invoices description: View invoices and their line items. - name: Job Titles description: Manage job title classifications for members. - name: Locations description: Manage office locations for members and projects. - name: Member Certifications description: Manage certification types that can be assigned to members. - name: Member Levels description: Manage member level classifications for career tracking. - name: Member Tags description: Manage tags for categorizing members. - name: Members description: Manage workspace members and their profiles. - name: Opportunities description: Manage sales opportunities in the CRM pipeline. - name: Opportunity Pipelines description: Manage pipelines for tracking opportunity stages. - name: Opportunity Lead Sources description: Manage lead source classifications for opportunities. - name: Opportunity Stages description: Manage pipeline stage definitions for opportunities. - name: Opportunity Tags description: Manage tags for categorizing opportunities. - name: Opportunity Types description: Manage type classifications for opportunities. - name: Payment Methods description: Manage payment method options for invoices. - name: Payments description: View payments received against invoices. - name: Pipeline Activities description: >- Manage pipeline activities associated with companies, contacts, members, and opportunities. - name: Pipeline Activity Types description: Manage activity type classifications for pipeline activities. - name: Practices description: Manage practice area classifications for organizing projects and members. - name: Project Budget Expenses description: Manage expense budget line items on projects. - name: Project Budget Other Items description: Manage other budget line items on projects. - name: Project Budget Product Items description: Manage product budget line items on projects. - name: Project Budget Service Items description: Manage additional service budget line items on projects. - name: Project Expenses description: Manage project-level expense line items. - name: Project Groups description: View project groups for organizing related projects. - name: Project Health Reports description: Manage project health status reports. - name: Project Invoice Milestones description: Manage invoice milestones for fixed-fee project billing. - name: Project Members description: Manage team member assignments on projects. - name: Project Monthly Budget Expenses description: Manage monthly expense budget line items on projects. - name: Project Monthly Budget Other Items description: Manage monthly other budget line items on projects. - name: Project Monthly Budget Product Items description: Manage monthly product budget line items on projects. - name: Project Monthly Budget Service Items description: Manage monthly additional service budget line items on projects. - name: Project Other Items description: Manage project-level other item line items. - name: Project Product Items description: Manage project-level product line items. - name: Project Revenue Adjustments description: Manage earned revenue adjustments for projects. - name: Project Revenue Recognition Entries description: Manage revenue recognition entries for projects. - name: Project Roles description: Manage roles defined on projects for billing and staffing. - name: Project Service Items description: Manage project-level additional service line items. - name: Project Tags description: Manage tags for categorizing projects. - name: Project Tasks description: Manage tasks on projects for time tracking and planning. - name: Project Types description: Manage type classifications for projects. - name: Projects description: Manage projects and their settings. - name: Resource Placeholders description: Manage placeholder resources for allocation planning. - name: Security Roles description: View security roles for assigning member permissions. - name: Skills description: Manage skill classifications for members and resource planning. - name: Task Categories description: Manage task category classifications for project tasks. - name: Task Tags description: Manage tags for categorizing project tasks. - name: Task Templates description: Manage reusable task templates for projects. - name: Tax Rates description: Manage tax rates for invoicing. - name: Time Entries description: Manage time entries for tracking hours on projects. - name: Time Off Types description: Manage time off type classifications. - name: Timesheet Attestations description: Manage attestation statements members sign when submitting timesheets. - name: Timesheets description: Manage timesheet submissions for tracking hours across a period. - name: Utilization Target Periods description: Manage member utilization target periods for capacity planning. - name: Workspace Roles description: Manage workspace-level roles for billing rate configuration. paths: /business-units: get: tags: - Business Units summary: List business units operationId: list-business-units parameters: - $ref: '#/components/parameters/StartingAfter' - $ref: '#/components/parameters/EndingBefore' - $ref: '#/components/parameters/Limit' - name: name in: query description: Filter by `name` when it exactly matches the provided keyword. schema: type: string responses: '200': description: '200' content: application/json: schema: type: object properties: results: type: array description: The list of results for the current page. items: $ref: '#/components/schemas/BusinessUnit' hasMore: type: boolean description: Whether there are more results available after this page. examples: Result: value: results: - id: d7a3f1e8-4c29-4b85-91d0-e6b7c2f03a18 name: West Region isActive: true companyName: Acme Corp - West streetAddress: |- 456 Market St San Francisco, CA 94105 invoiceSubject: Invoice for services rendered - West Region invoiceNotes: Payment due within terms specified. invoiceEmailSubject: Your invoice from Acme Corp - West invoiceEmailBody: >- Please find your invoice attached. Thank you for your business. invoiceEmailFromName: Acme West Billing invoiceEmailReplyTo: billing-west@acmecorp.com invoiceTaxableItems: - services - expenses createdAt: '2025-08-12T14:23:41.882Z' invoicePaymentTerm: id: b4e1c7a9-2d38-4f96-80d5-f3a7e6c02b19 name: Net 30 type: net days: 30 invoiceTaxRate: id: c9d2e5b8-3f47-4a81-92d6-e1b7c4f03a28 name: Standard Tax rate: 8.5 hasMore: false '400': description: '400' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: InvalidId: value: status: 400 message: Parameter 'startingAfter' is not a valid UUID. '403': description: '403' content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: Feature: value: status: 403 message: Feature 'Business Units' is not enabled. deprecated: false components: parameters: StartingAfter: name: startingAfter in: query description: >- A cursor ID (`uuid`) used to request the next page of results. If not provided, defaults to the first page of results. schema: type: string EndingBefore: name: endingBefore in: query description: >- A cursor ID (`uuid`) used to request the previous page of results. Is mutually exclusive with `startingAfter`. schema: type: string Limit: name: limit in: query description: >- The maximum number of results to be returned. Can be any number from 1 to 100. Defaults to 10, if not provided. schema: type: integer schemas: BusinessUnit: type: object properties: id: type: string description: The unique identifier for the object. name: type: string description: The name of the business unit. isActive: type: boolean description: Whether the business unit is active. companyName: type: - string - 'null' description: The company name displayed on invoices for this business unit. streetAddress: type: - string - 'null' description: The street address displayed on invoices for this business unit. invoiceSubject: type: - string - 'null' description: The default subject line for invoices. invoiceNotes: type: - string - 'null' description: The default notes for invoices. invoiceEmailSubject: type: - string - 'null' description: The default email subject when sending invoices. invoiceEmailBody: type: - string - 'null' description: The default email body when sending invoices. invoiceEmailFromName: type: - string - 'null' description: The sender name used when emailing invoices. invoiceEmailReplyTo: type: - string - 'null' description: The reply-to email address used when emailing invoices. invoiceTaxableItems: type: array description: The types of invoice line items that are taxable. items: type: string enum: - services - expenses - products - other_items createdAt: type: string format: date-time description: The timestamp when the object was created. invoicePaymentTerm: type: - object - 'null' description: The default payment term for invoices. properties: id: type: string description: The unique identifier for the object. name: type: string description: The name of the payment term. type: type: string description: The type of payment term. days: type: integer description: The number of days for the payment term. invoiceTaxRate: type: - object - 'null' description: The default tax rate for invoices. properties: id: type: string description: The unique identifier for the object. name: type: string description: The name of the tax rate. rate: type: number description: The tax rate percentage. example: id: d7a3f1e8-4c29-4b85-91d0-e6b7c2f03a18 name: West Region isActive: true companyName: Acme Corp - West streetAddress: |- 456 Market St San Francisco, CA 94105 invoiceSubject: Invoice for services rendered - West Region invoiceNotes: Payment due within terms specified. invoiceEmailSubject: Your invoice from Acme Corp - West invoiceEmailBody: Please find your invoice attached. Thank you for your business. invoiceEmailFromName: Acme West Billing invoiceEmailReplyTo: billing-west@acmecorp.com invoiceTaxableItems: - services - expenses createdAt: '2025-08-12T14:23:41.882Z' invoicePaymentTerm: id: b4e1c7a9-2d38-4f96-80d5-f3a7e6c02b19 name: Net 30 type: net days: 30 invoiceTaxRate: id: c9d2e5b8-3f47-4a81-92d6-e1b7c4f03a28 name: Standard Tax rate: 8.5 ErrorResponse: type: object properties: status: type: integer description: The HTTP status code. message: type: string description: A human-readable error message. securitySchemes: bearerAuth: type: http scheme: bearer ````