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

# People enrichment

> Get one person's full profile, contact details included

Send exactly one identifier: `id`, `work_email`, `ln_slug` or `ln_url`. Get a person's `id` from
[people search](https://docs.firmable.com/partner/people-search.md).

### The `required` parameter

| Value | Returned and charged when Firmable holds |
| - | - |
| `mobile` | A phone number |
| `email` | A work email |
| `either` | A phone number or a work email |
| `both` | A phone number and a work email |

When the person doesn't meet the requirement, no record is returned and nothing is charged.


## OpenAPI

````yaml GET /partner/{partner}/people/enrich
openapi: 3.0.1
info:
  title: Firmable API
  description: >-
    The Firmable API provides access to company and people data across multiple
    countries including Australia, New Zealand, Singapore, Malaysia, Indonesia,
    Philippines, Hong Kong, Japan, Vietnam, South Korea, Thailand, United
    States, and Canada. Use it to look up company profiles, retrieve contact
    information, and search for people by company, position, seniority, and
    department.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.firmable.com
security:
  - bearerAuth: []
paths:
  /partner/{partner}/people/enrich:
    get:
      description: >-
        Returns one person's full profile, contact details included. Send
        exactly one identifier.
      parameters:
        - name: partner
          in: path
          required: true
          description: >-
            Your platform's identifier. Firmable gives it to you during
            onboarding.
          schema:
            type: string
        - name: id
          in: query
          description: >-
            Firmable person id, starting fp, from people search. (example:
            fp000000000201)
          schema:
            type: string
        - name: work_email
          in: query
          description: A work email address.
          schema:
            type: string
        - name: ln_slug
          in: query
          description: LinkedIn profile slug.
          schema:
            type: string
        - name: ln_url
          in: query
          description: LinkedIn profile URL.
          schema:
            type: string
        - name: required
          in: query
          required: true
          description: >-
            The contact data the person must have. mobile: a phone number.
            email: a work email. either: a phone number or a work email. both: a
            phone number and a work email. When the requirement isn't met, no
            record is returned and nothing is charged.
          schema:
            type: string
            enum:
              - mobile
              - email
              - either
              - both
      responses:
        '200':
          description: The person's full profile
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerPerson'
              example:
                id: fp000000000201
                name: Jordan Lee
                first_name: Jordan
                last_name: Lee
                position: Chief Financial Officer
                seniority: C-Suite / Partner
                department: Finance
                headline: CFO at Harbourline Logistics
                country: AU
                location:
                  - Melbourne, VIC
                linkedin: jordan-lee-example
                time_in_current_role: Mar 2021 - Present
                month_joined: 3
                year_joined: 2021
                current_company:
                  id: f000000000101
                  name: Harbourline Logistics
                  website: https://www.harbourline.example
                  industry:
                    - Logistics and supply chain services
                  size: 251 - 500
                experience:
                  - company: Harbourline Logistics
                    positions:
                      - position: Chief Financial Officer
                        date_range: Mar 2021 - Present
                        location: Melbourne, Australia
                skills:
                  - Financial Reporting
                  - Treasury
                  - Supply Chain Finance
                phones:
                  - value: +61 400 000 000
                    is_dnd: false
                emails:
                  work:
                    - value: jordan.lee@harbourline.example
        '401':
          description: Missing or invalid API key
components:
  schemas:
    PartnerPerson:
      type: object
      properties:
        id:
          type: string
          description: Firmable person id
        name:
          type: string
          description: Full name
        first_name:
          type: string
          description: First name
        last_name:
          type: string
          description: Last name
        position:
          type: string
          description: Current job title
        seniority:
          type: string
          description: Seniority label
        department:
          type: string
          description: Department label
        headline:
          type: string
          description: Profile headline
        country:
          type: string
          description: Market code
        location:
          type: array
          items:
            type: string
          description: Locations
        linkedin:
          type: string
          description: LinkedIn profile slug
        time_in_current_role:
          type: string
          description: Date range of the current role
        month_joined:
          type: integer
          description: Month the current role started
        year_joined:
          type: integer
          description: Year the current role started
        current_company:
          type: object
          description: The person's current employer
          properties:
            id:
              type: string
              description: Firmable company id
            name:
              type: string
              description: Company name
            website:
              type: string
              description: Company website
            industry:
              type: array
              items:
                type: string
              description: Industry labels
            size:
              type: string
              description: Employee count band
        experience:
          type: array
          description: Work history, grouped by company
          items:
            type: object
            properties:
              company:
                type: string
                description: Company name
              positions:
                type: array
                items:
                  type: object
                  properties:
                    position:
                      type: string
                      description: Job title
                    date_range:
                      type: string
                      description: Date range
                    location:
                      type: string
                      description: Location
        skills:
          type: array
          items:
            type: string
          description: Skills
        phones:
          type: array
          description: Phone numbers
          items:
            type: object
            properties:
              value:
                type: string
                description: Phone number
              is_dnd:
                type: boolean
                description: The number is on a Do Not Call register
        emails:
          type: object
          description: Email addresses
          properties:
            work:
              type: array
              items:
                type: object
                properties:
                  value:
                    type: string
                    description: Work email
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

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