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

# Get a job by external ID

> Retrieve a job posting by the client-supplied `external_id` (unique within your organization). Returns 404 if no job in your organization has that external ID.



## OpenAPI

````yaml /swagger/v2_schema.yaml get /jobs/by-external-id/{external_id}
openapi: 3.0.3
info:
  title: TalentUnveiled API v2
  version: 2.0.0
  description: >-
    Public API v2 for managing jobs, applications, interviews, and webhooks.


    **Pagination:** list endpoints return a `{count, next, previous, results}`
    envelope. Page with the `limit` and `offset` query parameters; `limit`
    defaults to 50 and is capped at 200.
servers:
  - url: https://api.talentunveiled.com/api/v2
    description: Production server
security: []
tags:
  - name: Meta
    description: Identify the organization an API key belongs to.
  - name: Jobs
    description: Create, read, update, and archive job postings.
  - name: Applications
    description: Create applications and track them through the pipeline.
  - name: Interview Configuration
    description: The interview config and call schedule for a job.
  - name: Interview Criteria
    description: Evaluation criteria for a job's interview.
  - name: Interview Questions
    description: Questions asked during a job's interview.
  - name: Interview Results
    description: The scored interview result for an application.
  - name: Interview Calls
    description: Call attempts, scheduling, and transcripts.
  - name: CV Evaluations
    description: AI scoring of a candidate's CV against the job.
  - name: Insights
    description: Combined CV and interview insights for an application.
  - name: Webhooks
    description: Manage webhook subscriptions and inspect deliveries.
  - name: Hiring Team
    description: Manage the hiring team assigned to a job posting.
  - name: Members
    description: List the members of the organization.
paths:
  /jobs/by-external-id/{external_id}:
    get:
      tags:
        - Jobs
      summary: Get a job by external ID
      description: >-
        Retrieve a job posting by the client-supplied `external_id` (unique
        within your organization). Returns 404 if no job in your organization
        has that external ID.
      operationId: jobs_by_external_id_retrieve
      parameters:
        - in: path
          name: external_id
          schema:
            type: string
          required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobDetail'
          description: ''
        '401':
          description: Authentication credentials were not provided or are invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: The requested resource does not exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - apiKeyAuth: []
components:
  schemas:
    JobDetail:
      type: object
      description: >-
        Adds ``application_count``. Load the job with an ``application_count``

        annotation (``Count("applications")``) so no application rows are
        fetched.
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        external_id:
          type: string
          readOnly: true
          nullable: true
          description: >-
            The job's ID in the system that supplied it, in that system's own
            form. Unique per organization and source.
        external_id_source:
          allOf:
            - $ref: '#/components/schemas/ExternalIdSourceEnum'
          readOnly: true
          nullable: true
          description: |-
            Which system supplied external_id.

            * `api` - Public API
            * `kombo` - Kombo
            * `talent360` - Talent360
        title:
          type: string
          readOnly: true
        description:
          type: string
          readOnly: true
        location:
          type: string
          readOnly: true
        employment_type:
          allOf:
            - $ref: '#/components/schemas/EmploymentTypeEnum'
          readOnly: true
        status:
          allOf:
            - $ref: '#/components/schemas/JobStatusEnum'
          readOnly: true
        is_public:
          type: boolean
          readOnly: true
        language:
          allOf:
            - $ref: '#/components/schemas/LanguageEnum'
          readOnly: true
          description: |-
            Language for conducting interviews and generating CV evaluations

            * `en-US` - English
            * `de-DE` - German
        is_multilingual:
          type: boolean
          readOnly: true
          description: >-
            When enabled, the interview STARTS in `language` but the AI adapts
            to the candidate's spoken language. The call routes through a
            CallProfile flagged is_multilingual=True (must be configured at
            platform or org level). Analysis outputs (scoring, summary,
            insights) stay in `language` regardless of what the candidate spoke.
        cv_requirement:
          allOf:
            - $ref: '#/components/schemas/CvRequirementEnum'
          readOnly: true
          description: |-
            Controls whether candidates must upload a CV when applying

            * `required` - Required
            * `optional` - Optional
            * `disabled` - Disabled
        additional_information:
          type: string
          readOnly: true
          nullable: true
          description: >-
            Additional information about job posting that is not shown to
            candidate but used for internal system
        salary:
          allOf:
            - $ref: '#/components/schemas/JobSalary'
          nullable: true
          readOnly: true
        interview_config_id:
          type: string
          format: uuid
          nullable: true
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        application_count:
          type: integer
          readOnly: true
      required:
        - additional_information
        - application_count
        - created_at
        - cv_requirement
        - description
        - employment_type
        - external_id
        - external_id_source
        - id
        - interview_config_id
        - is_multilingual
        - is_public
        - language
        - location
        - salary
        - status
        - title
    ErrorResponse:
      type: array
      description: List of errors
      items:
        $ref: '#/components/schemas/ErrorItem'
    ExternalIdSourceEnum:
      enum:
        - api
        - kombo
        - talent360
      type: string
      description: |-
        * `api` - Public API
        * `kombo` - Kombo
        * `talent360` - Talent360
    EmploymentTypeEnum:
      enum:
        - full_time
        - part_time
        - contract
        - internship
        - freelance
      type: string
      description: |-
        * `full_time` - Full Time
        * `part_time` - Part Time
        * `contract` - Contract
        * `internship` - Internship
        * `freelance` - Freelance
    JobStatusEnum:
      enum:
        - active
        - paused
        - closed
        - draft
      type: string
      description: |-
        * `active` - Active
        * `paused` - Paused
        * `closed` - Closed
        * `draft` - Draft
    LanguageEnum:
      enum:
        - en-US
        - de-DE
      type: string
      description: |-
        * `en-US` - English
        * `de-DE` - German
    CvRequirementEnum:
      enum:
        - required
        - optional
        - disabled
      type: string
      description: |-
        * `required` - Required
        * `optional` - Optional
        * `disabled` - Disabled
    JobSalary:
      type: object
      description: Salary block; the whole object is null when no salary is set.
      properties:
        min:
          type: string
          format: decimal
          pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
          nullable: true
        max:
          type: string
          format: decimal
          pattern: ^-?\d{0,10}(?:\.\d{0,2})?$
          nullable: true
        currency:
          type: string
          nullable: true
        frequency:
          allOf:
            - $ref: '#/components/schemas/SalaryFrequencyEnum'
          nullable: true
      required:
        - currency
        - frequency
        - max
        - min
    ErrorItem:
      type: object
      description: Individual error item
      properties:
        code:
          allOf:
            - $ref: '#/components/schemas/ErrorCodeEnum'
          description: Machine-readable error code
        detail:
          type: string
          description: Human-readable error message
        attr:
          type: string
          nullable: true
          description: Field name this error relates to (for validation errors)
      required:
        - code
        - detail
    SalaryFrequencyEnum:
      enum:
        - per_hour
        - per_day
        - per_week
        - per_month
        - per_year
      type: string
      description: |-
        * `per_hour` - Per Hour
        * `per_day` - Per Day
        * `per_week` - Per Week
        * `per_month` - Per Month
        * `per_year` - Per Year
    ErrorCodeEnum:
      type: string
      enum:
        - error
        - invalid_input
        - parse_error
        - authentication_failed
        - not_authenticated
        - permission_denied
        - not_found
        - method_not_allowed
        - not_acceptable
        - unsupported_media_type
        - throttled
        - required
        - does_not_exist
        - incorrect_type
        - no_match
        - incorrect_match
        - not_a_list
        - not_a_dict
        - empty
        - candidate_user_mismatch
        - candidate_not_found
        - cross_organization_application
        - already_exists
        - call_service_error
        - call_not_joinable
        - call_config_error
        - call_access_denied
        - call_already_linked
        - date_range_too_large
        - date_range_start_after_end
        - invalid_date
        - language_not_configured
        - vapi_api_error
        - webhook_processing_error
        - proxy_error
        - configuration_error
        - interview_call_already_processed
        - call_type_switch_error
        - slot_in_past
        - interview_not_scheduled
        - interview_opt_out_not_eligible
        - interview_retry_not_allowed
        - retake_limit_reached
        - interview_session_not_joinable
        - interview_session_retake_not_eligible
        - interview_session_already_processing
        - interview_session_not_completed
        - interview_session_reset_not_allowed
        - interview_mode_locked
        - application_already_exists
        - gateway_verification_failed
        - invalid_file_type
        - file_too_large
        - cv_already_exists
        - cv_required
        - custom_fields_too_large
        - nylas_grant_already_exists
        - nylas_upstream_error
        - otp_challenge_not_found
        - job_posting_not_found
        - job_application_not_found
        - workflow_execution_error
        - llm_generation_failed
        - report_generation_failed
        - interview_config_has_no_criteria
        - scheduling_not_enabled
        - interview_session_not_reschedulable
        - interview_version_mismatch
        - v3_job_missing_config
        - idempotency_key_conflict
        - idempotency_key_invalid
        - application_status_transition_invalid
        - application_state_conflict
        - external_id_conflict
        - qualification_cannot_have_score
        - competency_requires_bars
      description: Machine-readable error code
  securitySchemes:
    apiKeyAuth:
      type: http
      scheme: bearer
      description: >-
        API key authentication for the public API. Pass your API key as a Bearer
        token.

````