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

# People profile

> Extract a structured person profile from a professional profile URL. Rate limit: 3,000 requests per minute per workspace.

Extract a structured person profile from a recognized LinkedIn URL, normally an `/in/` profile.

> [!NOTE]
>
> The limit is 3,000 requests per minute per workspace. The submitted URL selects the response schema and successful-call credit cost: `/in/` successes cost 1 credit by default, while `/company/` and `/school/` successes cost 0.5 credits. Workspace-specific pricing can differ, and unsuccessful requests are not charged.

## Request and response

Send a JSON body containing `linkedin_profile_url`. No other extraction settings are needed.

The response contains the available profile data. Fields may be missing or `null`, and their types can vary. The example illustrates one possible result; check the fields your integration uses before reading them.

## Errors and retries

A `404` means no profile was found. Check the URL before trying again. Correct the input for `400`, check your API key for `401`, and check access and credits for `403`.

For `429`, wait until the next minute before retrying. For temporary `502` or `503` responses, use a limited number of retries with increasing delays. If the errors persist, stop retrying and contact support. Unsuccessful requests are not charged; a lost response or client timeout does not confirm that the request failed.

## Next step

Use [Company profile](https://docs.airscale.io/api-reference/extract-company-profile.md) for the organization-focused guidance, or [Email finder](https://docs.airscale.io/api-reference/email-finder.md) to enrich a person profile.


## OpenAPI

````yaml openapi.json POST /v1/profile
openapi: 3.1.0
info:
  title: Airscale Public API
  version: '2026-09-11'
  description: >-
    Search, enrich, resolve public business data, and monitor job changes with
    Airscale.
  x-airscale-source-repository: ViceScale/airscale-code
  x-airscale-source-sha: 1de19e1b70a052a4b8d9c2075021a7e5e7a94d51
servers:
  - url: https://api.airscale.io
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Search and discovery
    description: Search people, companies, and the web.
  - name: Contact data
    description: Find professional and personal contact data.
  - name: Profiles and reverse lookup
    description: Extract profiles or resolve a person from known contact data.
  - name: Post engagement
    description: Retrieve and enrich people who liked or commented on LinkedIn posts.
  - name: LinkedIn content
    description: >-
      Search LinkedIn posts, read profile and company feeds, and retrieve
      profile comments and comment reactions.
  - name: Job change monitoring
    description: Track LinkedIn profiles and receive job-change events.
  - name: New hire monitoring
    description: Watch companies or the market for people who start a matching role.
  - name: Post engagement monitoring
    description: >-
      Follow LinkedIn company pages and profiles and receive the people who
      engage with their posts.
  - name: Account
    description: Inspect workspace account state.
  - name: Miscellaneous
    description: >-
      Find website technologies and check WhatsApp availability, Meta ads, and
      email deliverability.
paths:
  /v1/profile:
    post:
      tags:
        - Profiles and reverse lookup
      summary: Extract a person profile
      description: >-
        Extracts public profile data. The submitted URL determines whether the
        successful response is a person or company object.
      operationId: extractPersonProfile
      requestBody:
        required: true
        description: >-
          The LinkedIn URL is trimmed and a missing scheme is normalized. The
          hostname must be linkedin.com or a subdomain, and the first path
          segment must be /in/, /company/, or /school/. Query and extra path
          segments are canonicalized away. The submitted URL type chooses the
          person or company response and successful credit cost, regardless of
          which of these two routes receives it. Response fields and their types
          can vary; check for missing or null values before using them.
        content:
          application/json:
            schema:
              type: object
              required:
                - linkedin_profile_url
              additionalProperties: false
              properties:
                linkedin_profile_url:
                  type: string
                  minLength: 1
            examples:
              profile:
                summary: Extract a LinkedIn profile
                value:
                  linkedin_profile_url: linkedin.com/in/example-person-000000?source=synthetic
      responses:
        '200':
          description: The submitted URL selects a person or company profile response.
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/VariablePersonProfile'
                  - $ref: '#/components/schemas/VariableCompanyProfile'
              examples:
                success:
                  summary: Example profile
                  value:
                    url: https://www.linkedin.com/in/example-person-000000
                    identifier: example-person-000000
                    entityUrn: EXAMPLE000000
                    objectUrn: 100000001
                    firstname: Example
                    lastname: Person
                    middleName: null
                    birthDate: null
                    headline: Founder at Example Company
                    picture: https://www.example.org/images/example-person.png
                    background: https://www.example.org/images/example-background.png
                    summary: null
                    openToWork: false
                    influencer: false
                    premium: true
                    creator: false
                    hiring: false
                    verified: null
                    industry: Software Development
                    location:
                      country: United States
                      city: Example City
                      state: Example State
                      defaultValue: Example City, Example State, United States
                      shortValue: Example City, United States
                    organizations:
                      totalElements: 0
                      page: 0
                      size: 0
                      contents: []
                    educations:
                      totalElements: 1
                      page: 0
                      size: 1
                      contents:
                        - school:
                            id: 100001
                            name: Example University
                            logo: >-
                              https://www.example.org/images/example-university.png
                            url: >-
                              https://www.linkedin.com/school/example-university/
                            profileType: SCHOOL
                          degreeName: Master of Science
                          fieldOfStudy: Computer Science
                          grade: null
                          date:
                            start: '2014-01-01T00:00:00.000Z'
                            end: '2016-01-01T00:00:00.000Z'
                    patents:
                      totalElements: 0
                      page: 0
                      size: 0
                      contents: []
                    awards:
                      totalElements: 0
                      page: 0
                      size: 0
                      contents: []
                    certifications:
                      totalElements: 1
                      page: 0
                      size: 1
                      contents:
                        - name: Example Certification
                          authority: Example Institute
                          url: https://www.example.org/certificates/example
                          licenseNumber: EX-000001
                          displaySource: example.org
                          company:
                            id: 100003
                            name: Example Institute
                            logo: >-
                              https://www.example.org/images/example-institute.png
                            url: >-
                              https://www.linkedin.com/company/example-institute/
                            profileType: COMPANY
                          date:
                            start: '2022-01-01T00:00:00.000Z'
                            end: null
                    projects:
                      totalElements: 0
                      page: 0
                      size: 0
                      contents: []
                    publications:
                      totalElements: 0
                      page: 0
                      size: 0
                      contents: []
                    courses:
                      totalElements: 0
                      page: 0
                      size: 0
                      contents: []
                    testScores:
                      totalElements: 0
                      page: 0
                      size: 0
                      contents: []
                    positionGroups:
                      totalElements: 1
                      page: 0
                      size: 1
                      contents:
                        - company:
                            id: 100002
                            name: Example Company
                            logo: https://www.example.org/images/example-company.png
                            url: >-
                              https://www.linkedin.com/company/example-company-000000
                            domain: example.org
                            profileType: COMPANY
                          date:
                            start: '2021-03-01T00:00:00.000Z'
                            end: null
                          profilePositions:
                            - company: Example Company
                              description: null
                              title: Founder
                              employmentType: Permanent
                              location: Example City, United States
                              date:
                                start: '2021-03-01T00:00:00.000Z'
                                end: null
                    volunteerExperiences:
                      totalElements: 0
                      page: 0
                      size: 0
                      contents: []
                    languages:
                      totalElements: 1
                      page: 0
                      size: 1
                      contents:
                        - name: English
                          proficiency: NATIVE_OR_BILINGUAL
                    skills:
                      totalElements: 2
                      page: 0
                      size: 2
                      contents:
                        - Sales prospecting
                        - Data enrichment
        '400':
          description: The JSON body is invalid or a required input is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: >-
            The workspace cannot complete this request because access or
            available credits are insufficient.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No profile could be extracted for the submitted LinkedIn URL.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '413':
          description: The JSON request body exceeds the 256 KiB limit.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: >-
            The workspace rate limit has been exceeded. Try again after the
            current window resets.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: >-
            The request could not be completed because of an unexpected server
            error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '502':
          description: >-
            The request could not be completed because a required service
            returned an unsuccessful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: The request is temporarily unavailable. Try again later.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    VariablePersonProfile:
      type: object
      additionalProperties: true
      description: >-
        A flat person profile. Field types can vary by data source; check for
        missing or null values before using them. List sections are paginated
        objects with totalElements, page, size, and contents.
      properties:
        url:
          type:
            - string
            - 'null'
        identifier:
          type:
            - string
            - 'null'
        entityUrn:
          description: Profile URN, when available.
        objectUrn:
          description: Numeric profile identifier, when available.
        firstname:
          description: First name, when available.
        lastname:
          description: Last name, when available.
        middleName:
          description: Middle name, when available.
        birthDate:
          description: Birth date, when public.
        headline:
          description: Profile headline, when available.
        summary:
          description: Profile summary, when available.
        picture:
          description: Profile picture URL, when available.
        background:
          description: Background image URL, when available.
        industry:
          description: Industry, when available.
        openToWork:
          description: Open-to-work badge, when available.
        influencer:
          description: Influencer badge, when available.
        premium:
          description: Premium badge, when available.
        creator:
          description: Creator badge, when available.
        hiring:
          description: Hiring badge, when available.
        verified:
          description: Verified badge, when available.
        location:
          description: Location information, when available.
          properties:
            country:
              type:
                - string
                - 'null'
            city:
              type:
                - string
                - 'null'
            state:
              type:
                - string
                - 'null'
            defaultValue:
              type:
                - string
                - 'null'
              description: Full location text.
            shortValue:
              type:
                - string
                - 'null'
              description: Short location text.
        positionGroups:
          description: Work history grouped by company, most recent first.
          properties:
            totalElements: {}
            page: {}
            size: {}
            contents:
              type: array
              items:
                properties:
                  company:
                    properties:
                      id: {}
                      name: {}
                      logo: {}
                      url: {}
                      domain: {}
                      profileType: {}
                  date:
                    properties:
                      start: {}
                      end: {}
                  profilePositions:
                    type: array
                    items:
                      properties:
                        company: {}
                        description: {}
                        title: {}
                        employmentType: {}
                        location: {}
                        date:
                          properties:
                            start: {}
                            end: {}
        educations:
          description: Paginated list section, when available.
          properties:
            totalElements: {}
            page: {}
            size: {}
            contents:
              type: array
              items:
                properties:
                  school:
                    properties:
                      id: {}
                      name: {}
                      logo: {}
                      url: {}
                      profileType: {}
                  degreeName: {}
                  fieldOfStudy: {}
                  grade: {}
                  date:
                    properties:
                      start: {}
                      end: {}
        certifications:
          description: Paginated list section, when available.
          properties:
            totalElements: {}
            page: {}
            size: {}
            contents:
              type: array
              items:
                properties:
                  name: {}
                  authority: {}
                  url: {}
                  licenseNumber: {}
                  displaySource: {}
                  company:
                    properties:
                      id: {}
                      name: {}
                      logo: {}
                      url: {}
                      profileType: {}
                  date:
                    properties:
                      start: {}
                      end: {}
        languages:
          description: Paginated list section, when available.
          properties:
            totalElements: {}
            page: {}
            size: {}
            contents:
              type: array
              items:
                properties:
                  name: {}
                  proficiency: {}
        skills:
          description: Paginated list section, when available.
          properties:
            totalElements: {}
            page: {}
            size: {}
            contents:
              type: array
              items:
                type: string
        organizations:
          description: Paginated list section, when available.
          properties:
            totalElements: {}
            page: {}
            size: {}
            contents:
              type: array
              items: {}
        patents:
          description: Paginated list section, when available.
          properties:
            totalElements: {}
            page: {}
            size: {}
            contents:
              type: array
              items: {}
        awards:
          description: Paginated list section, when available.
          properties:
            totalElements: {}
            page: {}
            size: {}
            contents:
              type: array
              items: {}
        projects:
          description: Paginated list section, when available.
          properties:
            totalElements: {}
            page: {}
            size: {}
            contents:
              type: array
              items: {}
        publications:
          description: Paginated list section, when available.
          properties:
            totalElements: {}
            page: {}
            size: {}
            contents:
              type: array
              items: {}
        courses:
          description: Paginated list section, when available.
          properties:
            totalElements: {}
            page: {}
            size: {}
            contents:
              type: array
              items: {}
        testScores:
          description: Paginated list section, when available.
          properties:
            totalElements: {}
            page: {}
            size: {}
            contents:
              type: array
              items: {}
        volunteerExperiences:
          description: Paginated list section, when available.
          properties:
            totalElements: {}
            page: {}
            size: {}
            contents:
              type: array
              items: {}
        profile:
          description: Additional profile data, when available.
        link:
          description: Profile links, when available.
    VariableCompanyProfile:
      type: object
      additionalProperties: true
      description: >-
        A company profile. Field types can vary by data source; check for
        missing or null values before using them.
      properties:
        url:
          type:
            - string
            - 'null'
        name:
          type:
            - string
            - 'null'
        universalName:
          type:
            - string
            - 'null'
        website:
          type:
            - string
            - 'null'
        description:
          type:
            - string
            - 'null'
        type:
          description: Company type, for example Public Company.
        objectUrn:
          description: Numeric company identifier, when available.
        phone:
          description: Company phone, when public.
        followers:
          description: Follower count, when available.
        logo:
          description: Logo URL, when available.
        cover:
          description: Cover image URL, when available.
        tagline:
          description: Tagline, when available.
        foundedYear:
          description: Founding year, when available.
        staff:
          type:
            - object
            - 'null'
          additionalProperties: true
          properties:
            total:
              description: Employee count on the profile.
            range:
              description: Headcount band.
              properties:
                start: {}
                end: {}
        locations:
          type:
            - object
            - 'null'
          additionalProperties: true
          properties:
            headquarter:
              $ref: '#/components/schemas/CompanyAddress'
            other:
              type:
                - array
                - 'null'
              items:
                $ref: '#/components/schemas/CompanyAddress'
        fundingData:
          description: Funding details, when available.
        industries:
          type:
            - array
            - 'null'
          items: {}
        specialities:
          type:
            - array
            - 'null'
          items: {}
        hashtags:
          description: Company hashtags, when available.
    Error:
      type: object
      additionalProperties: true
      properties:
        error:
          type: string
        message:
          type: string
    CompanyAddress:
      type:
        - object
        - 'null'
      additionalProperties: true
      properties:
        country:
          type:
            - string
            - 'null'
        geographicArea:
          type:
            - string
            - 'null'
        city:
          type:
            - string
            - 'null'
        postalCode:
          type:
            - string
            - 'null'
        line1:
          type:
            - string
            - 'null'
        line2:
          type:
            - string
            - 'null'
        isPrimary:
          type:
            - boolean
            - 'null'
  responses:
    Unauthorized:
      description: The Bearer token is missing or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: >-
        Use an Airscale workspace API key. Never expose the key in client-side
        code.

````

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