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

# LinkedIn search people API

> Find public LinkedIn profiles by job title, company and location, with their details. Call the LinkedIn search people API for JSON. From 1 credit per call.

* **Endpoint:** `linkedin.people.search`
* **Returns:** `data` has `results`.
* **Cost:** 1 credit per 10 results, plus 1 credit per result that comes back with details (28 credits at most). Failed calls cost nothing.
* **Paging:** No.

Results come with profile details when LinkedIn shows them publicly. A result without details costs no extra credit.

## Example

<CodeGroup>
  ```typescript TypeScript icon="https://mintcdn.com/sirathic/7E4w9-IC4ysabjfc/images/icons/typescript.svg?fit=max&auto=format&n=7E4w9-IC4ysabjfc&q=85&s=d8272a85e64145620f1fbbfcf7932986" theme={null}
  import { Stophy } from "stophy";

  const stophy = new Stophy({ apiKey: process.env.STOPHY_API_KEY });
  const result = await stophy.linkedin.people.search({ title: "Head of Marketing", query: "SaaS" });
  console.log(result.data.results);
  ```

  ```python Python icon="python" theme={null}
  from stophy import Stophy

  stophy = Stophy()  # reads STOPHY_API_KEY
  result = stophy.linkedin.people.search(title="Head of Marketing", query="SaaS")
  print(result["data"]["results"])
  ```

  ```bash cURL icon="terminal" theme={null}
  curl -X POST https://api.stophy.dev/v1/linkedin/people/search \
    -H "Authorization: Bearer $STOPHY_API_KEY" \
    -H "content-type: application/json" \
    -d '{"title":"Head of Marketing","query":"SaaS"}'
  ```

  ```bash CLI icon="square-terminal" theme={null}
  stophy linkedin people search SaaS --title "Head of Marketing"
  ```
</CodeGroup>


## OpenAPI

````yaml api-reference/openapi.json POST /v1/linkedin/people/search
openapi: 3.1.0
info:
  title: Stophy API
  version: '1'
  description: >-
    Every endpoint is a POST that takes its input as a JSON object body. Unknown
    fields are rejected with 400.


    Responses leave out empty values: null, empty strings, empty objects and
    empty nested lists are not sent.


    x-credits is what one call costs. Every call costs the same, whatever it
    returns, unless an operation's description sets a price scale. Then
    x-credits is the lowest price and x-credits-max the highest.


    When a response has a cursor, send it back with the same input to get the
    next page.
servers:
  - url: https://api.stophy.dev
security:
  - apiKey: []
paths:
  /v1/linkedin/people/search:
    post:
      summary: >-
        Find public LinkedIn profiles by job title, company and location, with
        their details
      description: >-
        Costs 1 credit per 10 results, plus 1 credit per result that comes back
        with details.
      operationId: linkedinPeopleSearch
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                limit:
                  default: 10
                  description: How many results to return, up to 25.
                  type: integer
                  minimum: 1
                  maximum: 25
                query:
                  description: Free words to match, like a skill or industry.
                  type: string
                  minLength: 1
                  maxLength: 120
                title:
                  description: Current job title, like Head of Marketing.
                  type: string
                  minLength: 1
                  maxLength: 120
                company:
                  description: Current company, like Shopify.
                  type: string
                  minLength: 1
                  maxLength: 120
                location:
                  description: City or region shown on the profile, like Toronto.
                  type: string
                  minLength: 1
                  maxLength: 120
              additionalProperties: false
            example:
              title: Head of Marketing
              query: SaaS
      responses:
        '200':
          description: The data, and the credits this call used.
          headers:
            X-Request-ID:
              $ref: '#/components/headers/RequestId'
            x-credits-used:
              $ref: '#/components/headers/CreditsUsed'
            X-RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
            x-cache:
              $ref: '#/components/headers/Cache'
            x-cache-age:
              $ref: '#/components/headers/CacheAge'
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                  - creditsUsed
                  - requestId
                properties:
                  success:
                    const: true
                  data:
                    type: object
                    additionalProperties: false
                    properties:
                      results:
                        type: array
                        items:
                          type: object
                          additionalProperties: false
                          properties:
                            profileUrl:
                              type: string
                              format: uri
                            name:
                              type: string
                            headline:
                              type: string
                            title:
                              type: string
                            company:
                              type: string
                            location:
                              type: string
                            education:
                              type: string
                            details:
                              type: object
                              additionalProperties: false
                              properties:
                                profileId:
                                  type: string
                                headline:
                                  type: string
                                location:
                                  type: string
                                about:
                                  type: string
                                followers:
                                  type: integer
                                  minimum: -9007199254740991
                                  maximum: 9007199254740991
                                roles:
                                  type: array
                                  items:
                                    type: object
                                    additionalProperties: false
                                    properties:
                                      title:
                                        type: string
                                      company:
                                        type: string
                                      companyUrl:
                                        type: string
                                        format: uri
                                      from:
                                        type: string
                                      to:
                                        type: string
                                      isCurrent:
                                        type: boolean
                                    required:
                                      - isCurrent
                                education:
                                  type: array
                                  items:
                                    type: object
                                    additionalProperties: false
                                    properties:
                                      school:
                                        type: string
                                      degree:
                                        type: string
                                      schoolUrl:
                                        type: string
                                        format: uri
                                      from:
                                        type: string
                                      to:
                                        type: string
                                    required: []
                              required: []
                            position:
                              type: integer
                              minimum: -9007199254740991
                              maximum: 9007199254740991
                          required:
                            - profileUrl
                            - position
                    required:
                      - results
                  creditsUsed:
                    type: integer
                  requestId:
                    type: string
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/Error'
components:
  headers:
    RequestId:
      description: The request id. Quote it when you report a problem.
      schema:
        type: string
    CreditsUsed:
      description: Credits this call used.
      schema:
        type: integer
    RateLimitLimit:
      description: Requests allowed in the current window.
      schema:
        type: integer
    RateLimitRemaining:
      description: Requests left in the current window.
      schema:
        type: integer
    RateLimitReset:
      description: Unix time in seconds when the current window resets.
      schema:
        type: integer
    Cache:
      description: hit if this result came from the cache, miss if it was fetched live.
      schema:
        type: string
    CacheAge:
      description: Seconds since the returned result was written to the cache.
      schema:
        type: integer
    RetryAfter:
      description: Seconds to wait before retrying.
      schema:
        type: integer
  responses:
    Error:
      description: The request failed. retryable says whether trying again can help.
      headers:
        X-Request-ID:
          $ref: '#/components/headers/RequestId'
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      required:
        - success
        - error
      properties:
        success:
          const: false
        error:
          type: object
          required:
            - code
            - message
            - retryable
            - requestId
          properties:
            code:
              type: string
              enum:
                - agentCodeCompleted
                - agentCodeNotFound
                - agentEmailMismatch
                - cliSessionCompleted
                - cliSessionExists
                - cliSessionNotFound
                - forbidden
                - insufficientCredits
                - internalError
                - inviteClaimed
                - inviteDisabled
                - inviteExpired
                - inviteUsedUp
                - invalidCliSession
                - invalidCliVerifier
                - invalidRequest
                - notFound
                - rateLimited
                - sourceChanged
                - sourceRefused
                - sourceTimeout
                - sourceUnavailable
                - tooManyInFlight
                - unauthorized
                - unsupportedMediaType
            message:
              type: string
            retryable:
              type: boolean
            retryAfterSeconds:
              type: integer
            requestId:
              type: string
            requiredCredits:
              type: number
            availableCredits:
              type: number
            billingUrl:
              type: string
              const: https://stophy.dev/billing
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer

````

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