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

# Get Candidate By Id

> Returns a Candidate object with the given id.



## OpenAPI

````yaml get /api/ats/v1/candidates/{id}
openapi: 3.1.0
info:
  title: Bindbee APIs
  version: 0.1.0
servers:
  - url: https://api.bindbee.dev
  - url: https://api-eu.bindbee.dev
security: []
paths:
  /api/ats/v1/candidates/{id}:
    get:
      tags:
        - Candidate
      summary: Get Candidate By Id
      description: Returns a Candidate object with the given id.
      operationId: get_candidate_by_id_api_ats_v1_candidates__id__get
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Id
        - name: include_raw_data
          in: query
          required: false
          schema:
            type: boolean
            description: Include raw data in the response
            examples:
              - false
            default: false
            title: Include Raw Data
          description: Include raw data in the response
        - name: include_custom_fields
          in: query
          required: false
          schema:
            type: boolean
            description: Whether to include custom fields in the response.
            examples:
              - false
            default: false
            title: Include Custom Fields
          description: Whether to include custom fields in the response.
        - name: expand
          in: query
          required: false
          schema:
            type: string
            description: >-
              Which relations should be returned in expanded form. Multiple
              relation names should be comma separated without spaces. You can
              also specify required fields in [] for each relation name.
            examples:
              - manager[first_name,last_name]
            title: Expand
          description: >-
            Which relations should be returned in expanded form. Multiple
            relation names should be comma separated without spaces. You can
            also specify required fields in [] for each relation name.
        - name: x-connector-token
          in: header
          required: true
          schema:
            type: string
            title: X-Connector-Token
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AtsCandidate'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    AtsCandidate:
      properties:
        id:
          type: string
          format: uuid
          title: Id
          examples:
            - 018b18ef-c487-703c-afd9-0ca478ccd9d6
        remote_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Remote Id
          description: The third-party API ID of the matching object.
          examples:
            - '123321'
        modified_at:
          type: string
          title: Modified At
          description: This is the datetime that this object was last updated by Bindbee
          examples:
            - '2021-10-16T00:00:00Z'
        raw_data:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Raw Data
          description: This is the Raw data
          examples:
            - key_1: Platform dependent data 1
              key_2: Platform dependent data 2
        custom_fields:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Custom Fields
          description: The custom fields related to the model
          examples:
            - category_group: REG
              disability_type: ASBERG
              hire_date: '1991-03-16T00:00:00'
              hire_source: REFER
              nationality: USA
              original_hire_date: '1991-03-16T00:00:00'
        first_name:
          anyOf:
            - type: string
            - type: 'null'
          title: First Name
          description: The candidate's first name.
          examples:
            - John
        last_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Name
          description: The candidate's last name.
          examples:
            - Doe
        company:
          anyOf:
            - type: string
            - type: 'null'
          title: Company
          description: The name of the company where candidate has applied.
          examples:
            - Google
        title:
          anyOf:
            - type: string
            - type: 'null'
          title: Title
          description: The position for which the candidate has applied
          examples:
            - SOFTWARE ENGINEER
        last_interaction_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Interaction At
          description: The date of the last interaction with the candidate.
          examples:
            - '2021-07-01T00:00:00Z'
        is_private:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is Private
          description: Whether the candidate's information is private.
          examples:
            - true
        can_email:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Can Email
          description: Whether the candidate can be emailed.
          examples:
            - true
        locations:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Locations
          description: The location of the candidate.
          examples:
            - San Francisco
            - New York
        phone_numbers:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Phone Numbers
          description: The candidate's phone numbers.
          examples:
            - 123-456-7890
        email_addresses:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Email Addresses
          description: The candidate's email addresses.
          examples:
            - john@doe.com
        urls:
          anyOf:
            - items:
                $ref: '#/components/schemas/AtsUrl'
              type: array
            - type: 'null'
          title: Urls
          description: >-
            The candidate's URLs. This can include a personal website, LinkedIn
            profile, or other relevant URLs.
          examples:
            - type: LINKEDIN
              value: https://www.linkedin.com/in/johndoe
        tags:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Tags
          description: >-
            The candidate's tags. Tags are used to categorize candidates and can
            be used to filter candidates in the UI.
          examples:
            - JUNIOR
            - INTERMEDIATE
        applications:
          anyOf:
            - items: {}
              type: array
            - type: 'null'
          title: Applications
          description: The candidate's applications.
          examples:
            - 018b4bfb-5ece-70b1-ad5e-862a9433aa65
        attachments:
          anyOf:
            - items: {}
              type: array
            - type: 'null'
          title: Attachments
          description: The candidate's attachments.
          examples:
            - 018b4bfb-5ece-70b1-ad5e-862a9433aa65
        remote_created_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Remote Created At
          description: When the third party's candidate was created.
          examples:
            - '2021-07-01T00:00:00Z'
        remote_updated_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Remote Updated At
          description: When the third party's candidate was last updated.
          examples:
            - '2021-07-01T00:00:00Z'
        avatar:
          anyOf:
            - type: string
            - type: 'null'
          title: Avatar
          description: The candidate's avatar.
          examples:
            - https://www.example.com/avatar.jpg
      type: object
      required:
        - id
        - remote_id
        - modified_at
        - custom_fields
      title: AtsCandidate
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    AtsUrl:
      properties:
        value:
          anyOf:
            - type: string
            - type: 'null'
          title: Value
          description: The site's url.
        url_type:
          anyOf:
            - type: string
            - type: 'null'
          enum:
            - PERSONAL
            - COMPANY
            - PORTFOLIO
            - BLOG
            - SOCIAL_MEDIA
            - OTHER
            - JOB_POSTING
            - '-'
          title: Url Type
          description: >-
            The type of site. If the value is not one of the defined enum
            values, the original value passed through will be returned.
      type: object
      required:
        - value
        - url_type
      title: AtsUrl
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````