> ## 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.

# Create a company

An organization with which you have a history of communication or business, such as a potential client or partner. Each company can be linked to one or more contacts.


## OpenAPI

````yaml openapi.json POST /companies
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:
  /companies:
    post:
      tags:
        - Companies
      summary: Create a company
      operationId: create-a-company
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - name
              properties:
                name:
                  type: string
                  description: The name of the company. Max 255 characters.
                isActive:
                  type: boolean
                  description: Whether the company is active.
                description:
                  type: string
                  description: A description of the company. Max 5000 characters.
                billingAddress:
                  type: string
                  description: The billing address of the company. Max 5000 characters.
                currency:
                  type: string
                  description: >-
                    The three-letter currency code for the company. Defaults to
                    the workspace currency if not provided.
                facebookUrl:
                  type: string
                  description: The company's Facebook URL. Max 1024 characters.
                linkedinUrl:
                  type: string
                  description: The company's LinkedIn URL. Max 1024 characters.
                twitterUrl:
                  type: string
                  description: The company's Twitter URL. Max 1024 characters.
                websiteUrl:
                  type: string
                  description: The company's website URL. Max 1024 characters.
                numberOfEmployees:
                  type: integer
                  description: The number of employees.
                ownershipClass:
                  type: string
                  description: >-
                    The ownership class. Can be: `"public"` (Public),
                    `"private"` (Private), `"subsidiary"` (Subsidiary), or
                    `"other"` (Other).
                  enum:
                    - public
                    - private
                    - subsidiary
                    - other
                phoneNumber:
                  type: string
                  description: The phone number of the company. Max 255 characters.
                revenue:
                  type: number
                  description: The annual revenue of the company.
                shippingAddress:
                  type: string
                  description: The shipping address of the company. Max 5000 characters.
                tickerSymbol:
                  type: string
                  description: The stock ticker symbol for the company. Max 10 characters.
                yearFounded:
                  type: integer
                  description: The year the company was founded.
                companySpendTierId:
                  type: string
                  description: >-
                    The company spend tier ID (`uuid`) of the company spend tier
                    associated with this company.
                companyTypeId:
                  type: string
                  description: >-
                    The company type ID (`uuid`) of the company type associated
                    with this company.
                industryId:
                  type: string
                  description: >-
                    The industry ID (`uuid`) of the industry associated with
                    this company.
                ownerId:
                  type: string
                  description: The member ID (`uuid`) of the owner of this company.
                practiceId:
                  type: string
                  description: >-
                    The practice ID (`uuid`) of the practice associated with
                    this company.
                sicCodeId:
                  type: string
                  description: >-
                    The SIC code ID (`uuid`) of the SIC code associated with
                    this company.
                timeZoneId:
                  type: string
                  description: >-
                    The time zone ID (`uuid`) of the time zone associated with
                    this company.
      responses:
        '200':
          description: '200'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Company'
              examples:
                Result:
                  value:
                    id: a3f1c2d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d
                    name: Acme Corp
                    isActive: true
                    description: Enterprise technology company.
                    billingAddress: 100 Market St, Suite 500, San Francisco, CA 94105
                    currency: USD
                    facebookUrl: https://facebook.com/acmecorp
                    linkedinUrl: https://linkedin.com/company/acmecorp
                    twitterUrl: https://twitter.com/acmecorp
                    websiteUrl: https://acmecorp.com
                    numberOfEmployees: 5000
                    ownershipClass: public
                    phoneNumber: (555) 987-6543
                    revenue: 125000000
                    shippingAddress: 100 Market St, Suite 500, San Francisco, CA 94105
                    tickerSymbol: ACME
                    yearFounded: 1985
                    createdAt: '2025-01-15T20:47:03.284Z'
                    modifiedAt: '2025-01-15T20:47:03.284Z'
                    companySpendTier:
                      id: b4e2d3f5-6a7b-4c8d-9e0f-1a2b3c4d5e6f
                      name: Enterprise
                    companyType:
                      id: c5f3e4a6-7b8c-4d9e-0f1a-2b3c4d5e6f7a
                      name: Customer
                    practice:
                      id: d6a4f5b7-8c9d-4e0f-1a2b-3c4d5e6f7a8b
                      name: Technology
                    industry:
                      id: e7b5a6c8-9d0e-4f1a-2b3c-4d5e6f7a8b9c
                      name: Technology
                    owner:
                      id: f8c6b7d9-0e1f-4a2b-3c4d-5e6f7a8b9c0d
                      name: John Davis
                    sicCode:
                      id: a9d7c8e0-1f2a-4b3c-4d5e-6f7a8b9c0d1e
                      code: '7372'
                      industryTitle: Prepackaged Software
                    salesforceId: 0011600001LtMCkAAN
                    hubspotId: '12345678'
        '400':
          description: '400'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
              examples:
                Validation:
                  value:
                    status: 400
                    message: >-
                      There was a problem processing your request. See errors
                      for more details.
                    errors:
                      - '''name'' is required'
                InvalidData:
                  value:
                    status: 400
                    message: >-
                      'ownerId' 'bd44b42d-dd55-481a-b214-344c0539d367' does not
                      match a valid member.
        '403':
          description: '403'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Feature:
                  value:
                    status: 403
                    message: Feature 'Pipeline' is not enabled.
        '409':
          description: '409'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Duplicate:
                  value:
                    status: 409
                    message: A Company with the same name already exists.
      deprecated: false
components:
  schemas:
    Company:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for the object.
        name:
          type:
            - string
            - 'null'
          description: The name of the company.
        isActive:
          type: boolean
          description: Whether the company is active.
        description:
          type:
            - string
            - 'null'
          description: A description of the company.
        billingAddress:
          type:
            - string
            - 'null'
          description: The billing address of the company.
        currency:
          type: string
          description: The three-letter currency code for the company.
        facebookUrl:
          type:
            - string
            - 'null'
          description: The company's Facebook URL.
        linkedinUrl:
          type:
            - string
            - 'null'
          description: The company's LinkedIn URL.
        twitterUrl:
          type:
            - string
            - 'null'
          description: The company's Twitter URL.
        websiteUrl:
          type:
            - string
            - 'null'
          description: The company's website URL.
        numberOfEmployees:
          type:
            - integer
            - 'null'
          description: The number of employees.
        ownershipClass:
          type:
            - string
            - 'null'
          description: The ownership classification of the company.
          enum:
            - public
            - private
            - subsidiary
            - other
            - null
        phoneNumber:
          type:
            - string
            - 'null'
          description: The phone number of the company.
        revenue:
          type:
            - number
            - 'null'
          description: The annual revenue of the company.
        shippingAddress:
          type:
            - string
            - 'null'
          description: The shipping address of the company.
        tickerSymbol:
          type:
            - string
            - 'null'
          description: The stock ticker symbol for the company.
        yearFounded:
          type:
            - integer
            - 'null'
          description: The year the company was founded.
        createdAt:
          type: string
          format: date-time
          description: The timestamp when the object was created.
        modifiedAt:
          type: string
          format: date-time
          description: The timestamp when the object was last modified.
        companySpendTier:
          type:
            - object
            - 'null'
          description: The company spend tier associated with this company.
          properties:
            id:
              type: string
              description: The unique identifier for the object.
            name:
              type: string
              description: The name of the company spend tier.
        companyType:
          type:
            - object
            - 'null'
          description: The company type associated with this company.
          properties:
            id:
              type: string
              description: The unique identifier for the object.
            name:
              type: string
              description: The name of the company type.
        practice:
          type:
            - object
            - 'null'
          description: The practice associated with this company.
          properties:
            id:
              type: string
              description: The unique identifier for the object.
            name:
              type: string
              description: The name of the practice.
        industry:
          type:
            - object
            - 'null'
          description: The industry associated with this company.
          properties:
            id:
              type: string
              description: The unique identifier for the object.
            name:
              type: string
              description: The name of the industry.
        owner:
          type:
            - object
            - 'null'
          description: The workspace member who owns this company.
          properties:
            id:
              type: string
              description: The unique identifier for the object.
            name:
              type: string
              description: The name of the owner member.
        sicCode:
          type:
            - object
            - 'null'
          description: >-
            The Standard Industrial Classification (SIC) code associated with
            this company.
          properties:
            id:
              type: string
              description: The unique identifier for the object.
            code:
              type: string
              description: The SIC code value.
            industryTitle:
              type: string
              description: The industry title associated with the SIC code.
        salesforceId:
          type:
            - string
            - 'null'
          description: >-
            The Salesforce record ID for this company, if synced via Salesforce
            integration.
        hubspotId:
          type:
            - string
            - 'null'
          description: >-
            The HubSpot record ID for this company, if synced via HubSpot
            integration.
    ValidationErrorResponse:
      type: object
      properties:
        status:
          type: integer
          description: The HTTP status code.
        message:
          type: string
          description: A human-readable error message.
        errors:
          type: array
          description: A list of validation error messages.
          items:
            type: string
    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

````