PeopleForce API — Candidates

naftiko: 1.0.0-alpha2
info:
  label: PeopleForce API — Candidates
  description: 'PeopleForce API — Candidates. 3 operations. Lead operation: List candidates. Self-contained Naftiko capability
    covering one Peopleforce business surface.'
  tags:
  - Peopleforce
  - Candidates
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PEOPLEFORCE_API_KEY: PEOPLEFORCE_API_KEY
capability:
  consumes:
  - type: http
    namespace: peopleforce-candidates
    baseUri: https://app.peopleforce.io/api/public/v2
    description: PeopleForce API — Candidates business capability. Self-contained, no shared references.
    resources:
    - name: candidates
      path: /candidates
      operations:
      - name: get
        method: GET
        description: List candidates
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: page
          in: query
          type: integer
        - name: per_page
          in: query
          type: integer
      - name: post
        method: POST
        description: Create a candidate
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: candidates-id
      path: /candidates/{id}
      operations:
      - name: get
        method: GET
        description: Get a candidate
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          required: true
    authentication:
      type: bearer
      token: '{{env.PEOPLEFORCE_API_KEY}}'
  exposes:
  - type: rest
    namespace: peopleforce-candidates-rest
    port: 8080
    description: REST adapter for PeopleForce API — Candidates. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/candidates
      name: candidates
      description: REST surface for candidates.
      operations:
      - method: GET
        name: get
        description: List candidates
        call: peopleforce-candidates.get
        with:
          page: rest.page
          per_page: rest.per_page
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: post
        description: Create a candidate
        call: peopleforce-candidates.post
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/candidates/{id}
      name: candidates-id
      description: REST surface for candidates-id.
      operations:
      - method: GET
        name: get
        description: Get a candidate
        call: peopleforce-candidates.get
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: peopleforce-candidates-mcp
    port: 9090
    transport: http
    description: MCP adapter for PeopleForce API — Candidates. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-candidates
      description: List candidates
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: peopleforce-candidates.get
      with:
        page: tools.page
        per_page: tools.per_page
      outputParameters:
      - type: object
        mapping: $.
    - name: create-candidate
      description: Create a candidate
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: peopleforce-candidates.post
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-candidate
      description: Get a candidate
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: peopleforce-candidates.get
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.