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

# Get company profile

> Call company_profile through the Plyne API or MCP. Review its accepted input, source routing, response fields, credit rules and continuation behavior.

Resolve a company domain or LinkedIn company URL into a structured profile with source provenance.

## Usage

* The Plyne source reads the public LinkedIn company page directly over HTTP. It requires a public company slug URL; domain-only and numeric-ID lookups use other eligible sources. Selecting Plyne alone never invokes proxy or paid profile fallbacks. Historical observation provider IDs are retained internally.
* Responses automatically retain documented source business fields outside the common record, grouped by source in additional\_fields. Only exact common values are removed; differing aliases remain. Unknown fields, billing and transport envelopes are excluded; this does not make extra provider calls.

## API

Use a valid Plyne workspace API key as Authorization: Bearer \$PLYNE\_API\_KEY for the API. Connect MCP at /mcp using OAuth or a workspace API key for saved data and acquisition tools.

```bash theme={null}
curl "$PLYNE_API_URL/v1/tools/company_profile/execute" \
  -H "Authorization: Bearer $PLYNE_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: REPLACE_WITH_UNIQUE_REQUEST_ID' \
  --data '{
  "domain": "example.com"
}'
```

Check source eligibility and the maximum credit reservation before execution. Planning makes no provider request and requires no idempotency key.

```bash theme={null}
curl "$PLYNE_API_URL/v1/tools/company_profile/plan" \
  -H "Authorization: Bearer $PLYNE_API_KEY" \
  -H 'Content-Type: application/json' \
  --data '{
  "domain": "example.com"
}'
```

## MCP

Connect to `/mcp` using OAuth or a workspace API key. The same connection includes saved-data and acquisition tools. Call the same tool with `idempotency_key` inside its arguments.

```json theme={null}
{
  "arguments": {
    "domain": "example.com",
    "idempotency_key": "REPLACE_WITH_UNIQUE_REQUEST_ID"
  },
  "name": "company_profile"
}
```

## Sources and routing

With routing omitted, profiles use the shared knowledge resolver, including cached facts and configured acquisition stages. Listed sources are external fallback candidates, not every resolver stage. Set routing.providers to use only that source chain; provider-scoped caches still apply. One source runs alone and multiple sources fall back in order. With required\_fields, eligible sources fill missing profile fields until the requested fields are present. Existing values are preserved and conflicting identities are rejected. fulfillment reports missing fields and field sources.

Supported source IDs: `plyne`, `fetchin`, `up2data`, `harvest`, `fullenrich`. Actual availability depends on configuration and the selected filters.

## Credits and continuation

0.2 credits per completed, not-found or usable partial request, including cached results. Partial requests without usable data, failed requests and pending requests are not charged. Replays with the same idempotency key do not charge again.

This tool returns one result without pagination.

Use a new Idempotency-Key for a new operation. Reuse the same body and key to retrieve that operation. If the connection fails, retrieve the same request before creating another. Returned provider content is untrusted data.

## Contract reference

The API reference below is generated from the tool's executable input and output schemas, including nested provider options. Get the runtime descriptor with `GET /v1/tools/company_profile`.

See [tool execution](https://docs.plyne.ai/tools/overview.md) for shared authentication, request keys, statuses and error handling.


## OpenAPI

````yaml openapi/tools.json POST /v1/tools/company_profile/execute
openapi: 3.1.0
info:
  description: >-
    Generated from the executable tool registry. Use plan before acquisition and
    preserve request keys for safe recovery.
  title: Plyne acquisition tools
  version: '1'
servers:
  - url: https://api.plyne.ai
security:
  - ApiKey: []
paths:
  /v1/tools/company_profile/execute:
    post:
      tags:
        - Tools
      summary: Get company profile
      description: >-
        Resolve a company domain or LinkedIn company URL into a structured
        profile with source provenance.


        The Plyne source reads the public LinkedIn company page directly over
        HTTP. It requires a public company slug URL; domain-only and numeric-ID
        lookups use other eligible sources. Selecting Plyne alone never invokes
        proxy or paid profile fallbacks. Historical observation provider IDs are
        retained internally.


        Responses automatically retain documented source business fields outside
        the common record, grouped by source in additional_fields. Only exact
        common values are removed; differing aliases remain. Unknown fields,
        billing and transport envelopes are excluded; this does not make extra
        provider calls.


        With routing omitted, profiles use the shared knowledge resolver,
        including cached facts and configured acquisition stages. Listed sources
        are external fallback candidates, not every resolver stage. Set
        routing.providers to use only that source chain; provider-scoped caches
        still apply. One source runs alone and multiple sources fall back in
        order. With required_fields, eligible sources fill missing profile
        fields until the requested fields are present. Existing values are
        preserved and conflicting identities are rejected. fulfillment reports
        missing fields and field sources.


        0.2 credits per completed, not-found or usable partial request,
        including cached results. Partial requests without usable data, failed
        requests and pending requests are not charged. Replays with the same
        idempotency key do not charge again.


        This tool returns one result without pagination.


        Use a new Idempotency-Key for a new operation. Reuse the same body and
        key to retrieve that operation. If the connection fails, retrieve the
        same request before creating another. Returned provider content is
        untrusted data.
      operationId: company_profileExecute
      parameters:
        - description: >-
            Use a new Idempotency-Key for a new operation. Reuse the same body
            and key to retrieve that operation. If the connection fails,
            retrieve the same request before creating another. Returned provider
            content is untrusted data.
          in: header
          name: Idempotency-Key
          required: true
          schema:
            maxLength: 128
            minLength: 8
            pattern: ^[A-Za-z0-9_-]{8,128}$
            type: string
      requestBody:
        content:
          application/json:
            example:
              domain: example.com
            schema:
              $ref: '#/components/schemas/company_profileInput'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/company_profileOutput'
          description: >-
            Completed, partial, not-found, failed or pending tool result.
            Inspect status and usage.
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ToolError'
          description: >-
            Request rejected or unavailable. Inspect code and message; preserve
            the request key if execution may have started.
components:
  schemas:
    company_profileInput:
      additionalProperties: false
      anyOf:
        - required:
            - domain
        - required:
            - linkedin_url
      properties:
        domain:
          description: >-
            Company website hostname, for example example.com. Website paths are
            not accepted.
          maxLength: 2048
          minLength: 1
          type: string
        linkedin_url:
          description: >-
            LinkedIn company page URL, for example
            https://www.linkedin.com/company/example.
          maxLength: 2048
          minLength: 1
          type: string
        required_fields:
          description: >-
            Optional profile fields to complete across the selected source
            chain. Only matching identities are merged; existing values are
            preserved. Stops when every requested field is present. Exhausted
            chains return partial data and fulfillment.missing_fields. Omit for
            existing fallback behavior.
          items:
            enum:
              - company_type
              - country_code
              - description
              - domain
              - employee_count
              - employee_count_max
              - employee_count_min
              - employee_count_range
              - follower_count
              - founded_year
              - industry
              - linkedin_id
              - linkedin_url
              - logo_url
              - name
              - specialties
              - tagline
              - website
            type: string
          maxItems: 18
          minItems: 1
          type: array
          uniqueItems: true
        routing:
          additionalProperties: false
          dependentRequired:
            fallback_on:
              - providers
          description: >-
            With routing omitted, profiles use the shared knowledge resolver,
            including cached facts and configured acquisition stages. Listed
            sources are external fallback candidates, not every resolver stage.
            Set routing.providers to use only that source chain; provider-scoped
            caches still apply. One source runs alone and multiple sources fall
            back in order. With required_fields, eligible sources fill missing
            profile fields until the requested fields are present. Existing
            values are preserved and conflicting identities are rejected.
            fulfillment reports missing fields and field sources.
          properties:
            fallback_on:
              description: >-
                When to try the next source. Defaults to error and empty; has no
                effect for one source.
              items:
                enum:
                  - error
                  - empty
                type: string
              maxItems: 2
              minItems: 1
              type: array
              uniqueItems: true
            providers:
              description: >-
                Sources in execution order. One entry uses only that source.
                Omit to use the default chain.
              items:
                enum:
                  - plyne
                  - fetchin
                  - up2data
                  - harvest
                  - fullenrich
                type: string
              maxItems: 5
              minItems: 1
              type: array
              uniqueItems: true
          type: object
      type: object
    company_profileOutput:
      additionalProperties: false
      properties:
        data:
          additionalProperties: false
          properties:
            additional_fields:
              additionalProperties: false
              properties:
                fetchin:
                  additionalProperties: false
                  properties:
                    autoGenerated:
                      type: boolean
                    claimable:
                      type: boolean
                    companyId:
                      type: string
                    companyType:
                      type: string
                    companyTypeCode:
                      type: string
                    coverImageUrl:
                      type: string
                    description:
                      type: string
                    domain:
                      type: string
                    employeeCount:
                      type: integer
                    employeeCountRange:
                      additionalProperties: false
                      properties:
                        end:
                          type: integer
                        start:
                          type: integer
                      type: object
                    followerCount:
                      type: integer
                    foundedOn:
                      additionalProperties: false
                      properties:
                        year:
                          type: integer
                      type: object
                    hashtags:
                      items:
                        type: string
                      type: array
                    headquarter:
                      additionalProperties: false
                      properties:
                        country:
                          type: string
                      type: object
                    id:
                      type: string
                    industry:
                      type: string
                    industryV1:
                      type: string
                    locations:
                      items:
                        additionalProperties: false
                        properties:
                          city:
                            type: string
                          country:
                            type: string
                          description:
                            type: string
                          geographicArea:
                            type: string
                          headquarter:
                            type: boolean
                          line1:
                            type: string
                          line2:
                            type: string
                          postalCode:
                            type: string
                        type: object
                      type: array
                    logoUrl:
                      type: string
                    name:
                      type: string
                    publicIdentifier:
                      type: string
                    specialities:
                      items:
                        type: string
                      type: array
                    tagline:
                      type: string
                    url:
                      type: string
                    websiteUrl:
                      type: string
                  type: object
                fullenrich:
                  additionalProperties: false
                  properties:
                    company_type:
                      type: string
                    description:
                      type: string
                    domain:
                      type: string
                    headcount:
                      type: integer
                    headcount_range:
                      type: string
                    id:
                      type: string
                    industry:
                      additionalProperties: false
                      properties:
                        main_industry:
                          type: string
                      type: object
                    locations:
                      additionalProperties: false
                      properties:
                        headquarters:
                          additionalProperties: false
                          properties:
                            city:
                              type: string
                            country:
                              type: string
                            country_code:
                              type: string
                            line1:
                              type: string
                            line2:
                              type: string
                            region:
                              type: string
                          type: object
                        offices:
                          items:
                            additionalProperties: false
                            properties:
                              line1:
                                type: string
                              line2:
                                type: string
                            type: object
                          type: array
                      type: object
                    logo_url:
                      type: string
                    name:
                      type: string
                    social_profiles:
                      additionalProperties: false
                      properties:
                        linkedin:
                          additionalProperties: false
                          properties:
                            connection_count:
                              type: integer
                            handle:
                              type: string
                            id:
                              type: integer
                            url:
                              type: string
                          type: object
                        professional_network:
                          additionalProperties: false
                          properties:
                            connection_count:
                              type: integer
                            handle:
                              type: string
                            id:
                              type: integer
                            url:
                              type: string
                          type: object
                      type: object
                    specialties:
                      items:
                        type: string
                      type: array
                    technologies:
                      items:
                        additionalProperties: false
                        properties:
                          logo_url:
                            type: string
                          name:
                            type: string
                        type: object
                      type: array
                    website:
                      type: string
                    year_founded:
                      type: integer
                  type: object
                harvest:
                  additionalProperties: false
                  properties:
                    active:
                      type: boolean
                    affiliatedPages:
                      items:
                        additionalProperties: false
                        properties:
                          description:
                            type: string
                          followerCount:
                            type: integer
                          id:
                            type: string
                          industries:
                            items:
                              additionalProperties: false
                              properties:
                                hierarchy:
                                  type: string
                                id:
                                  type: string
                                name:
                                  type: string
                                title:
                                  type: string
                                urn:
                                  type: string
                              type: object
                            type: array
                          linkedinUrl:
                            type: string
                          logo:
                            type: string
                          logos:
                            items:
                              additionalProperties: false
                              properties:
                                height:
                                  type: integer
                                url:
                                  type: string
                                width:
                                  type: integer
                              type: object
                            type: array
                          name:
                            type: string
                          paidCompany:
                            type: boolean
                          showcase:
                            type: boolean
                          universalName:
                            type: string
                        type: object
                      type: array
                    autoGenerated:
                      type: boolean
                    backgroundCover:
                      type: string
                    backgroundCovers:
                      items:
                        additionalProperties: false
                        properties:
                          height:
                            type: integer
                          url:
                            type: string
                          width:
                            type: integer
                        type: object
                      type: array
                    callToActionUrl:
                      type: string
                    companyType:
                      type: string
                    description:
                      type: string
                    employeeCount:
                      type: integer
                    employeeCountRange:
                      additionalProperties: false
                      properties:
                        end:
                          type: integer
                        start:
                          type: integer
                      type: object
                    followerCount:
                      type: integer
                    foundedOn:
                      additionalProperties: false
                      properties:
                        year:
                          type: integer
                      type: object
                    id:
                      type: string
                    industries:
                      items:
                        additionalProperties: false
                        properties:
                          hierarchy:
                            type: string
                          id:
                            type: string
                          name:
                            type: string
                          title:
                            type: string
                          urn:
                            type: string
                        type: object
                      type: array
                    jobSearchUrl:
                      type: string
                    linkedinUrl:
                      type: string
                    locations:
                      items:
                        additionalProperties: false
                        properties:
                          city:
                            type: string
                          country:
                            type: string
                          description:
                            type: string
                          geographicArea:
                            type: string
                          headquarter:
                            type: boolean
                          line1:
                            type: string
                          line2:
                            type: string
                          parsed:
                            additionalProperties: false
                            properties:
                              city:
                                type: string
                              country:
                                type: string
                              countryCode:
                                type: string
                              countryFull:
                                type: string
                              regionCode:
                                type: string
                              state:
                                type: string
                              text:
                                type: string
                            type: object
                          postalCode:
                            type: string
                        type: object
                      type: array
                    logo:
                      type: string
                    logos:
                      items:
                        additionalProperties: false
                        properties:
                          height:
                            type: integer
                          url:
                            type: string
                          width:
                            type: integer
                        type: object
                      type: array
                    name:
                      type: string
                    pageType:
                      type: string
                    pageVerified:
                      type: boolean
                    paidCompany:
                      type: boolean
                    showcase:
                      type: boolean
                    similarOrganizations:
                      items:
                        additionalProperties: false
                        properties:
                          backgroundCover:
                            type: string
                          description:
                            type: string
                          employeeCountRange:
                            additionalProperties: false
                            properties:
                              end:
                                type: integer
                              start:
                                type: integer
                            type: object
                          followerCount:
                            type: integer
                          id:
                            type: string
                          industries:
                            items:
                              additionalProperties: false
                              properties:
                                hierarchy:
                                  type: string
                                id:
                                  type: string
                                name:
                                  type: string
                                title:
                                  type: string
                                urn:
                                  type: string
                              type: object
                            type: array
                          linkedinUrl:
                            type: string
                          logo:
                            type: string
                          name:
                            type: string
                          universalName:
                            type: string
                        type: object
                      type: array
                    specialities:
                      items:
                        type: string
                      type: array
                    tagline:
                      type: string
                    universalName:
                      type: string
                    website:
                      type: string
                  type: object
                up2data:
                  additionalProperties: false
                  properties:
                    company_size:
                      additionalProperties: false
                      properties:
                        max:
                          type: integer
                        min:
                          type: integer
                      type: object
                    company_type:
                      type: string
                    cover_image_url:
                      type: string
                    description:
                      type: string
                    followers_count:
                      type: integer
                    founded:
                      type: integer
                    funding:
                      additionalProperties: false
                      properties:
                        last_round:
                          additionalProperties: false
                          properties:
                            amount_usd:
                              type: integer
                            date:
                              type: string
                            type:
                              type: string
                          type: object
                        total_usd:
                          type: integer
                      type: object
                    hashtags:
                      items:
                        type: string
                      type: array
                    headcount:
                      type: integer
                    headcount_growth_6m:
                      type: number
                    hq:
                      additionalProperties: false
                      properties:
                        address:
                          type: string
                        address_2:
                          type: string
                        city:
                          type: string
                        country:
                          type: string
                        latitude:
                          type: number
                        longitude:
                          type: number
                        postal_code:
                          type: string
                        raw:
                          type: string
                        region:
                          type: string
                      type: object
                    industry:
                      type: string
                    industry_v2:
                      type: string
                    linkedin_id:
                      type: string
                    locations:
                      items:
                        additionalProperties: false
                        properties:
                          address:
                            type: string
                          city:
                            type: string
                          country:
                            type: string
                          is_hq:
                            type: boolean
                          latitude:
                            type: number
                          longitude:
                            type: number
                          postal_code:
                            type: string
                          region:
                            type: string
                        type: object
                      type: array
                    logo_url:
                      type: string
                    name:
                      type: string
                    scraped_at:
                      type: string
                    specialties:
                      items:
                        type: string
                      type: array
                    tagline:
                      type: string
                    url:
                      type: string
                    website:
                      type: string
                  type: object
              type: object
            company_type:
              type: string
            company_type_status:
              type: string
            country_code:
              type: string
            description:
              type: string
            domain:
              type: string
            employee_count:
              minimum: 0
              type:
                - integer
                - 'null'
            employee_count_max:
              minimum: 0
              type:
                - integer
                - 'null'
            employee_count_min:
              minimum: 0
              type:
                - integer
                - 'null'
            employee_count_range:
              type: string
            follower_count:
              minimum: 0
              type:
                - integer
                - 'null'
            founded_year:
              minimum: 0
              type:
                - integer
                - 'null'
            industry:
              type: string
            industry_status:
              type: string
            linkedin_id:
              type: string
            linkedin_url:
              type: string
            logo_url:
              type: string
            name:
              type: string
            specialties:
              items:
                type: string
              type: array
            tagline:
              type: string
            website:
              type: string
          type:
            - object
            - 'null'
        error:
          additionalProperties: false
          properties:
            code:
              type: string
            message:
              type: string
            retryable:
              type: boolean
          required:
            - code
            - message
            - retryable
          type:
            - object
            - 'null'
        fulfillment:
          properties:
            field_sources:
              additionalProperties:
                items:
                  properties:
                    observation_id:
                      type: string
                    observed_at:
                      properties: {}
                      type: object
                    provider:
                      type: string
                    url:
                      type: string
                  type: object
                type: array
              type: object
            missing_fields:
              items:
                type: string
              type: array
            satisfied:
              type: boolean
          type: object
        id:
          type: string
        routing:
          additionalProperties: false
          properties:
            attempts:
              items:
                additionalProperties: false
                properties:
                  outcome:
                    enum:
                      - success
                      - partial
                      - pending
                      - error
                      - empty
                    type: string
                  provider:
                    type: string
                  requests:
                    minimum: 0
                    type: integer
                required:
                  - provider
                  - outcome
                  - requests
                type: object
              type: array
            mode:
              enum:
                - auto
                - single
                - fallback
              type: string
            selected_provider:
              type: string
          required:
            - mode
          type: object
        sources:
          items:
            additionalProperties: false
            properties:
              observation_id:
                type: string
              observed_at:
                format: date-time
                type: string
              provider:
                type: string
              url:
                type: string
            required:
              - provider
            type: object
          type: array
        status:
          enum:
            - completed
            - partial
            - not_found
            - failed
            - pending
          type: string
        tool:
          const: company_profile
          type: string
        usage:
          additionalProperties: false
          properties:
            credit_units:
              minimum: 0
              type: integer
            credits:
              type: string
            unit:
              const: request
              type: string
          required:
            - credit_units
            - credits
            - unit
          type:
            - object
            - 'null'
        version:
          const: '1'
          type: string
        warnings:
          items:
            additionalProperties: false
            properties:
              code:
                type: string
              message:
                type: string
            required:
              - code
              - message
            type: object
          type: array
      required:
        - id
        - tool
        - version
        - status
        - data
        - sources
        - usage
        - error
      type: object
    ToolError:
      properties:
        code:
          type: string
        message:
          type: string
      required:
        - code
        - message
      type: object
  securitySchemes:
    ApiKey:
      scheme: bearer
      type: http

````

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