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

# Get Profile

> Retrieve the full profile of a talent, including contact details (emails and phone numbers with WhatsApp reachability) and the CV inline as base64. Typically called with an `id` returned in a talent search result.

This is a paid feature that must be activated on your organisation (PRO plan), separately from talent search. Full-profile retrievals are metered per organisation with a monthly cap — **every call counts** (there is no de-duplication). [Learn more](/docs/searching-talents).



## OpenAPI

````yaml GET /profile/{id}
openapi: 3.0.1
info:
  title: Collective Work Job API
  description: API for managing job postings on the Collective Work platform
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.collective.work/{environment}/v1
    description: Collective Work API server
    variables:
      environment:
        default: sandbox
        description: API environment
        enum:
          - sandbox
          - production
security:
  - bearerAuth: []
paths:
  /profile/{id}:
    get:
      description: >-
        Retrieve the full profile of a talent, including contact details (emails
        and phone numbers with WhatsApp reachability) and the CV inline as
        base64. Typically called with an `id` returned in a talent search
        result.


        This is a paid feature that must be activated on your organisation (PRO
        plan), separately from talent search. Full-profile retrievals are
        metered per organisation with a monthly cap — **every call counts**
        (there is no de-duplication). [Learn more](/docs/searching-talents).
      parameters:
        - in: path
          name: id
          schema:
            type: string
          required: true
          description: Unique identifier of the talent (as returned in search results)
      responses:
        '200':
          description: Profile retrieved successfully
          headers:
            X-Monthly-Quota-Remaining:
              description: >-
                Production only. Profile retrievals remaining for the
                organization this calendar month, including this successful
                retrieval. Repeated retrievals of the same talent each consume
                quota. Concurrent requests may change the balance. Omitted in
                sandbox.
              schema:
                type: integer
                minimum: 0
              example: 42
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiFullProfileDto'
        '402':
          description: Monthly profile retrieval limit reached
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error402'
        '403':
          description: >-
            Invalid API key, or organization not activated for full-profile
            retrieval
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Profile not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error404'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error500'
components:
  schemas:
    ApiFullProfileDto:
      type: object
      required:
        - id
        - firstname
        - lastname
        - pictureUrl
        - linkedinUrl
        - collectiveUrl
        - title
        - dailyRate
        - yearlySalaryMin
        - yearlySalaryMax
        - availability
        - workPreference
        - desiredContractType
        - location
        - mobilities
        - skills
        - featuredSkills
        - workExperiences
        - intro
        - educations
        - languages
        - certifications
        - links
        - emails
        - phones
        - cv
      properties:
        id:
          type: string
          description: Unique identifier of the talent
          example: cm71yqftr00000ck0bpz3hpg1
        firstname:
          type: string
          description: First name of the talent
          example: Jane
        lastname:
          type: string
          description: Last name of the talent
          example: Doe
        pictureUrl:
          type: string
          nullable: true
          description: Profile picture URL
          example: https://pictures.example.com/jane.png
        linkedinUrl:
          type: string
          nullable: true
          description: LinkedIn profile URL of the talent (may be null when unknown)
          example: https://www.linkedin.com/in/jane-doe
        collectiveUrl:
          type: string
          description: >-
            Deep link to open the talent profile inside the Collective recruiter
            app
          example: >-
            https://app.collective.work/recruiter/search?profileId=cmjr2j27g2xzy6dgjauv8hbc1
        title:
          type: string
          nullable: true
          description: Professional headline / title
          example: Senior Frontend Engineer
        dailyRate:
          type: number
          nullable: true
          description: Desired daily rate in euros
          example: 650
        yearlySalaryMin:
          type: number
          nullable: true
          description: Minimum desired yearly salary in euros
          example: 60000
        yearlySalaryMax:
          type: number
          nullable: true
          description: Maximum desired yearly salary in euros
          example: 80000
        availability:
          type: string
          nullable: true
          enum:
            - AVAILABLE
          description: >-
            Whether the talent is available now. Returns `AVAILABLE`, or `null`
            when the talent is not available or has not set their availability.
            Resolved the same way as the Collective app.
          example: AVAILABLE
        workPreference:
          type: string
          nullable: true
          enum:
            - REMOTE_ONLY
            - FLEXIBLE
          description: Preferred way of working
          example: REMOTE_ONLY
        desiredContractType:
          type: string
          nullable: true
          enum:
            - FREELANCER
            - FREELANCER_OPEN_TO_PERMANENT_CONTRACT
            - PERMANENT_CONTRACT
          description: Desired contract type
          example: FREELANCER
        location:
          description: Primary work location
          nullable: true
          allOf:
            - $ref: '#/components/schemas/ApiLocationDto'
        mobilities:
          type: array
          description: Locations the talent is willing to work in
          items:
            $ref: '#/components/schemas/ApiLocationDto'
        skills:
          type: array
          description: Skills
          items:
            type: string
          example:
            - TypeScript
            - GraphQL
        featuredSkills:
          type: array
          description: >-
            Featured skills — the skills the talent is best at (a highlighted
            subset of `skills`)
          items:
            type: string
          example:
            - React
        workExperiences:
          type: array
          description: Work experiences
          items:
            $ref: '#/components/schemas/ApiProfileWorkExperienceDto'
        intro:
          type: string
          nullable: true
          description: Short introduction / summary
          example: Frontend engineer with 8 years building design systems.
        educations:
          type: array
          description: Educations
          items:
            $ref: '#/components/schemas/ApiProfileEducationDto'
        languages:
          type: array
          description: Languages
          items:
            $ref: '#/components/schemas/ApiProfileLanguageDto'
        certifications:
          type: array
          description: Certifications
          items:
            $ref: '#/components/schemas/ApiProfileCertificationDto'
        links:
          type: array
          description: External links
          items:
            $ref: '#/components/schemas/ApiProfileLinkDto'
        emails:
          type: array
          description: Email addresses found
          items:
            $ref: '#/components/schemas/ApiProfileEmailDto'
        phones:
          type: array
          description: Phone numbers found
          items:
            $ref: '#/components/schemas/ApiProfilePhoneDto'
        cv:
          description: >-
            Talent CV as base64-encoded document data. Null when the talent has
            no CV (we don't have one for everyone).
          nullable: true
          allOf:
            - $ref: '#/components/schemas/CvDto'
    Error402:
      type: object
      required:
        - message
        - error
        - statusCode
      properties:
        message:
          type: array
          items:
            type: string
          example:
            - Monthly profile retrieval limit reached
        statusCode:
          type: integer
          example: 402
        error:
          type: string
          example: Payment Required
    Error403:
      type: object
      required:
        - message
        - error
        - statusCode
      properties:
        message:
          type: array
          items:
            type: string
        statusCode:
          type: integer
          example: 403
        error:
          type: string
          example: Forbidden
    Error404:
      type: object
      required:
        - message
        - error
        - statusCode
      properties:
        message:
          type: array
          items:
            type: string
          example:
            - Resource not found
        statusCode:
          type: integer
          example: 404
        error:
          type: string
          example: Not Found
    Error500:
      type: object
      required:
        - message
        - error
        - statusCode
      properties:
        message:
          type: array
          items:
            type: string
          example:
            - Internal server error
        statusCode:
          type: integer
          example: 500
        error:
          type: string
          example: Internal Server Error
    ApiLocationDto:
      type: object
      required:
        - googleMapsPlaceId
        - country
        - countryCode
        - label
        - shortLabel
        - latitude
        - longitude
      properties:
        googleMapsPlaceId:
          type: string
          nullable: true
          description: Google Maps place identifier, usable to re-query the location
          example: ChIJdw3OtdnQZ0cRziAfbWk74Go
        country:
          type: string
          nullable: true
          description: Full English country name
          example: France
        countryCode:
          type: string
          nullable: true
          description: ISO 3166-1 alpha-2 country code
          enum:
            - AF
            - AX
            - AL
            - DZ
            - AS
            - AD
            - AO
            - AI
            - AQ
            - AG
            - AR
            - AM
            - AW
            - AU
            - AT
            - AZ
            - BS
            - BH
            - BD
            - BB
            - BY
            - BE
            - BZ
            - BJ
            - BM
            - BT
            - BO
            - BQ
            - BA
            - BW
            - BV
            - BR
            - IO
            - BN
            - BG
            - BF
            - BI
            - CV
            - KH
            - CM
            - CA
            - KY
            - CF
            - TD
            - CL
            - CN
            - CX
            - CC
            - CO
            - KM
            - CG
            - CD
            - CK
            - CR
            - CI
            - HR
            - CU
            - CW
            - CY
            - CZ
            - DK
            - DJ
            - DM
            - DO
            - EC
            - EG
            - SV
            - GQ
            - ER
            - EE
            - SZ
            - ET
            - FK
            - FO
            - FJ
            - FI
            - FR
            - GF
            - PF
            - TF
            - GA
            - GM
            - GE
            - DE
            - GH
            - GI
            - GR
            - GL
            - GD
            - GP
            - GU
            - GT
            - GG
            - GN
            - GW
            - GY
            - HT
            - HM
            - VA
            - HN
            - HK
            - HU
            - IS
            - IN
            - ID
            - IR
            - IQ
            - IE
            - IM
            - IL
            - IT
            - JM
            - JP
            - JE
            - JO
            - KZ
            - KE
            - KI
            - KP
            - KR
            - KW
            - KG
            - LA
            - LV
            - LB
            - LS
            - LR
            - LY
            - LI
            - LT
            - LU
            - MO
            - MG
            - MW
            - MY
            - MV
            - ML
            - MT
            - MH
            - MQ
            - MR
            - MU
            - YT
            - MX
            - FM
            - MD
            - MC
            - MN
            - ME
            - MS
            - MA
            - MZ
            - MM
            - NA
            - NR
            - NP
            - NL
            - NC
            - NZ
            - NI
            - NE
            - NG
            - NU
            - NF
            - MK
            - MP
            - 'NO'
            - OM
            - PK
            - PW
            - PS
            - PA
            - PG
            - PY
            - PE
            - PH
            - PN
            - PL
            - PT
            - PR
            - QA
            - RE
            - RO
            - RU
            - RW
            - BL
            - SH
            - KN
            - LC
            - MF
            - PM
            - VC
            - WS
            - SM
            - ST
            - SA
            - SN
            - RS
            - SC
            - SL
            - SG
            - SX
            - SK
            - SI
            - SB
            - SO
            - ZA
            - GS
            - SS
            - ES
            - LK
            - SD
            - SR
            - SJ
            - SE
            - CH
            - SY
            - TW
            - TJ
            - TZ
            - TH
            - TL
            - TG
            - TK
            - TO
            - TT
            - TN
            - TR
            - TM
            - TC
            - TV
            - UG
            - UA
            - AE
            - GB
            - UM
            - US
            - UY
            - UZ
            - VU
            - VE
            - VN
            - VG
            - VI
            - WF
            - EH
            - XK
            - YE
            - ZM
            - ZW
          example: FR
        label:
          type: string
          nullable: true
          description: Full display label of the location
          example: Paris, France
        shortLabel:
          type: string
          nullable: true
          description: Short display label of the location
          example: Paris
        latitude:
          type: number
          nullable: true
          description: Latitude of the location
          example: 48.8566
        longitude:
          type: number
          nullable: true
          description: Longitude of the location
          example: 2.3522
    ApiProfileWorkExperienceDto:
      type: object
      required:
        - title
        - company
        - companyLogoUrl
        - startDate
        - endDate
        - description
        - location
      properties:
        title:
          type: string
          description: Job title held
          example: Senior Frontend Engineer
        company:
          type: string
          nullable: true
          description: Company name
          example: Collective
        companyLogoUrl:
          type: string
          nullable: true
          description: Company logo URL
          example: https://logo.example.com/collective.png
        startDate:
          type: string
          format: date-time
          nullable: true
          description: Start date of the experience
          example: '2021-01-01T00:00:00.000Z'
        endDate:
          type: string
          format: date-time
          nullable: true
          description: End date of the experience (null if ongoing)
          example: '2023-06-30T00:00:00.000Z'
        description:
          type: string
          nullable: true
          description: Free-text description of the role
          example: Led the design system team and migrated the app to React 18.
        location:
          description: >-
            Work location. Only the `label` is populated today; the structured
            fields are reserved for future geocoding.
          nullable: true
          allOf:
            - $ref: '#/components/schemas/ApiLocationDto'
    ApiProfileEducationDto:
      type: object
      required:
        - school
        - degreeName
        - field
        - description
        - startDate
        - endDate
      properties:
        school:
          type: string
          nullable: true
          description: School or institution name
          example: École Polytechnique
        degreeName:
          type: string
          nullable: true
          description: Degree obtained
          example: MSc Computer Science
        field:
          type: string
          nullable: true
          description: Field of study
          example: Computer Science
        description:
          type: string
          nullable: true
          description: Free-text description of the education
          example: Specialised in distributed systems and machine learning.
        startDate:
          type: string
          format: date-time
          nullable: true
          description: Start date of the education
          example: '2014-09-01T00:00:00.000Z'
        endDate:
          type: string
          format: date-time
          nullable: true
          description: End date of the education
          example: '2017-06-30T00:00:00.000Z'
    ApiProfileLanguageDto:
      type: object
      required:
        - language
      properties:
        language:
          type: string
          description: Language name
          example: English
    ApiProfileCertificationDto:
      type: object
      required:
        - name
        - companyName
        - issueDate
      properties:
        name:
          type: string
          description: Certification name
          example: AWS Certified Solutions Architect
        companyName:
          type: string
          description: Issuing authority
          example: Amazon Web Services
        issueDate:
          type: string
          format: date-time
          nullable: true
          description: Date the certification was issued
          example: '2022-03-01T00:00:00.000Z'
    ApiProfileLinkDto:
      type: object
      required:
        - name
        - url
      properties:
        name:
          type: string
          description: Link label
          example: GitHub
        url:
          type: string
          description: Link URL
          example: https://github.com/jane
    ApiProfileEmailDto:
      type: object
      required:
        - email
      properties:
        email:
          type: string
          description: Email address
          example: jane.doe@example.com
    ApiProfilePhoneDto:
      type: object
      required:
        - phoneNumber
        - whatsappValidity
      properties:
        phoneNumber:
          type: string
          description: Phone number
          example: '+33612345678'
        whatsappValidity:
          type: string
          enum:
            - VALID
            - INVALID
            - UNKNOWN
          description: Whether the phone number is reachable on WhatsApp
          example: VALID
    CvDto:
      type: object
      required:
        - fileName
        - contentType
        - data
      properties:
        fileName:
          type: string
          description: Name of the CV file
          example: resume.pdf
        contentType:
          type: string
          description: MIME type of the CV file
          example: application/pdf
        data:
          type: string
          description: Base64 encoded CV document data
          example: JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PC...
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Your organization API key, available in [Organisation
        settings](https://app.collective.work/recruiter/organization/api).

````

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