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

# Search Companies

> Find companies by name or domain among stored profiles, then on the web when filters are not set.



## OpenAPI

````yaml /openapi-public.json post /v1/company/search
openapi: 3.1.0
info:
  title: url2llm
  version: 0.1.0
servers: []
security: []
paths:
  /v1/company/search:
    post:
      tags:
        - public
        - company
      summary: Search Companies
      description: >-
        Find companies by name or domain among stored profiles, then on the web
        when filters are not set.
      operationId: searchCompanies
      parameters:
        - in: header
          name: Idempotency-Key
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Idempotency-Key
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanySearchRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIResponse_CompanySearchResponse_'
          description: Successful Response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResult'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResult'
          description: Unauthorized
        '402':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResult'
          description: Payment Required
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResult'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResult'
          description: Not Found
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResult'
          description: Conflict
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResult'
          description: Unprocessable Content
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResult'
          description: Too Many Requests
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResult'
          description: Internal Server Error
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResult'
          description: Service Unavailable
        '504':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResult'
          description: Gateway Timeout
      security:
        - HTTPBearer: []
components:
  schemas:
    CompanySearchRequest:
      additionalProperties: false
      description: >-
        A name or domain to match, stored-field filters that all must hold, or
        both.
      properties:
        country:
          anyOf:
            - pattern: ^[A-Za-z]{2}$
              type: string
            - type: 'null'
          description: ISO 3166-1 alpha-2 code
          title: Country
        hasEmail:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Hasemail
        hasPhone:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Hasphone
        limit:
          default: 10
          maximum: 20
          minimum: 1
          title: Limit
          type: integer
        pixels:
          description: Every one must be detected
          items:
            type: string
          maxItems: 20
          title: Pixels
          type: array
        query:
          anyOf:
            - maxLength: 200
              minLength: 1
              type: string
            - type: 'null'
          description: Company name or domain
          title: Query
        technologies:
          description: Every one must be detected
          items:
            type: string
          maxItems: 20
          title: Technologies
          type: array
      title: CompanySearchRequest
      type: object
    APIResponse_CompanySearchResponse_:
      properties:
        data:
          anyOf:
            - $ref: '#/components/schemas/CompanySearchResponse'
            - type: 'null'
        message:
          anyOf:
            - type: string
            - type: 'null'
          title: Message
        meta:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Meta
        request_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Request Id
        success:
          default: true
          title: Success
          type: boolean
      required:
        - success
        - data
        - meta
        - message
        - request_id
      title: APIResponse[CompanySearchResponse]
      type: object
    ErrorResult:
      properties:
        error:
          $ref: '#/components/schemas/ApiError'
        request_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Request Id
        success:
          default: false
          title: Success
          type: boolean
      required:
        - success
        - error
        - request_id
      title: ErrorResult
      type: object
    CompanySearchResponse:
      properties:
        credits_used:
          title: Credits Used
          type: integer
        request_id:
          title: Request Id
          type: integer
        results:
          items:
            $ref: '#/components/schemas/CompanySearchResult'
          title: Results
          type: array
        warning:
          anyOf:
            - type: string
            - type: 'null'
          title: Warning
      required:
        - results
        - request_id
        - warning
        - credits_used
      title: CompanySearchResponse
      type: object
    ApiError:
      properties:
        code:
          title: Code
          type: string
        details:
          anyOf:
            - {}
            - type: 'null'
          title: Details
        message:
          title: Message
          type: string
      required:
        - code
        - message
        - details
      title: ApiError
      type: object
    CompanySearchResult:
      properties:
        company:
          anyOf:
            - $ref: '#/components/schemas/CompanySummary'
            - type: 'null'
          description: Null when no profile is stored
        domain:
          description: The company's registrable domain
          title: Domain
          type: string
        snippet:
          anyOf:
            - type: string
            - type: 'null'
          title: Snippet
        source:
          description: index for a stored company, search for a web result
          enum:
            - index
            - search
          title: Source
          type: string
        title:
          anyOf:
            - type: string
            - type: 'null'
          title: Title
        url:
          title: Url
          type: string
      required:
        - domain
        - source
        - url
        - title
        - snippet
        - company
      title: CompanySearchResult
      type: object
    CompanySummary:
      description: The stored profile of a result's company.
      properties:
        country:
          anyOf:
            - type: string
            - type: 'null'
          description: ISO 3166-1 alpha-2 code
          title: Country
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        has_email:
          default: false
          title: Has Email
          type: boolean
        has_phone:
          default: false
          title: Has Phone
          type: boolean
        logo:
          anyOf:
            - type: string
            - type: 'null'
          description: The logo lockup, else the first icon
          title: Logo
        pixels:
          items:
            type: string
          title: Pixels
          type: array
        refreshed_at:
          description: When the stored profile was last refreshed
          format: date-time
          title: Refreshed At
          type: string
        socials:
          items:
            $ref: '#/components/schemas/CompanySocial'
          title: Socials
          type: array
        technologies:
          items:
            type: string
          title: Technologies
          type: array
        title:
          anyOf:
            - type: string
            - type: 'null'
          description: The brand name
          title: Title
      required:
        - title
        - description
        - logo
        - country
        - socials
        - technologies
        - pixels
        - has_email
        - has_phone
        - refreshed_at
      title: CompanySummary
      type: object
    CompanySocial:
      properties:
        type:
          description: >-
            Platform slug, or other for a known profile site without its own
            slug
          title: Type
          type: string
        url:
          title: Url
          type: string
      required:
        - type
        - url
      title: CompanySocial
      type: object
  securitySchemes:
    HTTPBearer:
      description: 'Send an active organization API key in the Authorization: Bearer header.'
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.