> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stardex.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get company by ID

> Retrieve detailed information about a specific company including client status, owners, enriched data, and custom field values. Custom fields are included by default; pass `include=` (empty) for base fields only.



## OpenAPI

````yaml /api-reference/openapi-v1.json get /v1/companies/{id}
openapi: 3.1.0
info:
  title: Stardex API (v1)
  version: 1.0.0
  description: >-
    Stardex ATS API — manage candidates, jobs, companies, and recruiting
    workflows.
servers:
  - url: https://api.stardex.ai
    description: Production API server
security:
  - bearerAuth: []
tags:
  - name: Persons
    description: Manage person records — contacts, work history, and custom fields.
  - name: Jobs
    description: Manage job postings — pipeline stages, team members, and custom fields.
  - name: Candidates
    description: Manage candidate records and pipeline stage transitions.
  - name: Companies
    description: Browse and retrieve company records.
  - name: Lists
    description: Create, search, and retrieve saved person and company lists.
  - name: Person Activities
    description: Create and manage activity records (notes, emails, meetings) for persons.
  - name: Team Members
    description: List team members for use in search filters and assignments.
  - name: Custom Fields
    description: Retrieve custom field definitions and tag options for search filters.
paths:
  /v1/companies/{id}:
    get:
      tags:
        - Companies
      summary: Get company by ID
      description: >-
        Retrieve detailed information about a specific company including client
        status, owners, enriched data, and custom field values. Custom fields
        are included by default; pass `include=` (empty) for base fields only.
      operationId: getCompanyById
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
            description: Company ID
        - schema:
            type: string
            description: >-
              Comma-separated extra sections. Values: custom_fields. Default:
              custom_fields. Pass empty string for base fields only.
          required: false
          name: include
          in: query
      responses:
        '200':
          description: Company fetched
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyByIdResponse'
              example:
                success: true
                data:
                  id: 456e7890-e12b-34d5-a678-901234567890
                  name: Acme Corp
                  domain: acme.com
                  linkedin_url: https://www.linkedin.com/company/acme
                  linkedin_id: 12345678
                  location: San Francisco, CA
                  phone: +1-555-0100
                  description: >-
                    Leading technology solutions provider specializing in
                    enterprise SaaS.
                  is_client: true
                  do_not_contact: true
                  do_not_contact_metadata:
                    reason: Active client — protect from sourcing
                    do_not_contact_added_by: 234e5678-e90a-12b3-c456-789012345678
                    date_added: '2024-06-01T09:00:00Z'
                    last_updated_at: '2024-06-15T14:30:00Z'
                    last_updated_by: 234e5678-e90a-12b3-c456-789012345678
                    expiration_date: '2024-09-15T00:00:00Z'
                  created_at: '2024-01-05T10:00:00Z'
                  date_of_last_engagement: '2024-06-15T14:30:00Z'
                  client_status:
                    id: 789e0123-e45f-67a8-b901-234567890123
                    name: Active
                  enriched_company:
                    id: ec123456-7890-abcd-ef01-234567890abc
                    name: Acme Corp
                    domain: acme.com
                    linkedin_url: https://www.linkedin.com/company/acme
                  owners:
                    - id: 234e5678-e90a-12b3-c456-789012345678
                      first_name: Jane
                      last_name: Smith
                  custom_fields:
                    - attribute_id: e5f6a7b8-c9d0-1234-efab-567890123456
                      attribute_name: Industry
                      data_type: single-select
                      value: null
                      tag:
                        id: f6a7b8c9-d0e1-2345-fabc-678901234567
                        name: Technology
                      team_member: null
                    - attribute_id: a7b8c9d0-e1f2-3456-abcd-789012345678
                      attribute_name: Account Owner
                      data_type: multi-team-member
                      value: null
                      tag: null
                      team_member:
                        id: 234e5678-e90a-12b3-c456-789012345678
                        name: Jane Smith
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                    description: Always false for error responses.
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: >-
                          Machine-readable error code (e.g. "VALIDATION_ERROR",
                          "NOT_FOUND").
                      message:
                        type: string
                        description: Human-readable error description.
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                    description: Always false for error responses.
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: >-
                          Machine-readable error code (e.g. "VALIDATION_ERROR",
                          "NOT_FOUND").
                      message:
                        type: string
                        description: Human-readable error description.
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                    description: Always false for error responses.
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: >-
                          Machine-readable error code (e.g. "VALIDATION_ERROR",
                          "NOT_FOUND").
                      message:
                        type: string
                        description: Human-readable error description.
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
components:
  schemas:
    CompanyByIdResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - true
        data:
          $ref: '#/components/schemas/CompanyDetail'
      required:
        - success
        - data
    CompanyDetail:
      type: object
      properties:
        id:
          type: string
          description: Company UUID.
        name:
          type: string
          description: Company name.
        domain:
          type:
            - string
            - 'null'
          description: Website domain.
        linkedin_url:
          type:
            - string
            - 'null'
          description: LinkedIn company page URL.
        linkedin_id:
          type:
            - number
            - 'null'
          description: LinkedIn numeric company ID.
        location:
          type:
            - string
            - 'null'
          description: Company headquarters location.
        phone:
          type:
            - string
            - 'null'
          description: Company phone number.
        description:
          type:
            - string
            - 'null'
          description: Company description.
        is_client:
          type: boolean
          description: True if company is a client.
        do_not_contact:
          type: boolean
          description: True if flagged do-not-contact.
        do_not_contact_metadata:
          type:
            - object
            - 'null'
          additionalProperties: {}
          description: Do-not-contact metadata.
        created_at:
          type: string
          description: ISO 8601 creation timestamp.
        date_of_last_engagement:
          type:
            - string
            - 'null'
          description: ISO 8601 timestamp of the most recent engagement.
        client_status:
          type:
            - object
            - 'null'
          properties:
            id:
              type: string
              description: Client status UUID.
            name:
              type: string
              description: >-
                Client status label (e.g. "Active", "Prospect", "Former
                Client").
          required:
            - id
            - name
          description: Current client lifecycle status. Null if not a client.
        enriched_company:
          type:
            - object
            - 'null'
          properties:
            id:
              type: string
              description: Enriched company UUID.
            name:
              type: string
              description: Enriched company name.
            domain:
              type:
                - string
                - 'null'
              description: Enriched domain.
            linkedin_url:
              type:
                - string
                - 'null'
              description: Enriched LinkedIn URL.
          required:
            - id
            - name
            - domain
            - linkedin_url
          description: Enriched company data snapshot.
        owners:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: Team member UUID.
              first_name:
                type:
                  - string
                  - 'null'
                description: First name.
              last_name:
                type:
                  - string
                  - 'null'
                description: Last name.
            required:
              - id
              - first_name
              - last_name
          description: Team members who own this company.
        custom_fields:
          type: array
          items:
            $ref: '#/components/schemas/CustomFieldValue'
          description: Custom field values. Included when include contains "custom_fields".
      required:
        - id
        - name
        - domain
        - linkedin_url
        - linkedin_id
        - location
        - phone
        - description
        - is_client
        - do_not_contact
        - do_not_contact_metadata
        - created_at
        - date_of_last_engagement
        - client_status
        - enriched_company
        - owners
    CustomFieldValue:
      type: object
      properties:
        attribute_id:
          type: string
          format: uuid
          description: >-
            Attribute definition UUID. Get definitions from GET
            /v1/custom-fields/{entity}.
        attribute_name:
          type: string
          description: Attribute display name.
        data_type:
          type: string
          enum:
            - string
            - integer
            - decimal
            - multi-select
            - single-select
            - boolean
            - date
            - multi-team-member
            - url
          description: Attribute data type. Determines which value field contains the data.
        job_id:
          type:
            - string
            - 'null'
          format: uuid
          description: >-
            Job UUID this attribute is scoped to. Null for global person-level
            attributes. Present when this custom field is specific to a job
            (candidate-level field).
        list_id:
          type:
            - string
            - 'null'
          format: uuid
          description: >-
            List UUID this attribute is scoped to. Null for global person-level
            attributes.
        value:
          anyOf:
            - type: string
            - type: number
            - type: boolean
            - type: 'null'
            - type: 'null'
          description: >-
            Scalar value for string, integer, decimal, date, url, boolean types.
            Null for select/team-member types.
        tag:
          type:
            - object
            - 'null'
          properties:
            id:
              type: string
              format: uuid
              description: Tag option UUID.
            name:
              type: string
              description: Tag display name.
          required:
            - id
            - name
          description: >-
            Tag value for single-select and multi-select types. Null for other
            types. For multi-select, one CustomFieldValue row per tag.
        team_member:
          type:
            - object
            - 'null'
          properties:
            id:
              type: string
              format: uuid
              description: Team member UUID.
            name:
              type:
                - string
                - 'null'
              description: Team member full name.
          required:
            - id
            - name
          description: >-
            Team member value for multi-team-member type. Null for other types.
            One CustomFieldValue row per team member.
      required:
        - attribute_id
        - attribute_name
        - data_type
        - job_id
        - list_id
        - value
        - tag
        - team_member
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Authenticate with a Bearer token: API key, OAuth token, or session
        token.

````