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

# Get Worker Credential

> Returns a single credential record for a specific worker.



## OpenAPI

````yaml api-reference/v01.12.00/openapi-v01.12.00.json GET /workers/{id}/credentials/{credentials_id}
openapi: 3.0.0
info:
  title: Roosted
  version: 0.1.12
  contact:
    name: Support
    url: https://support.roostedhr.com/support/home
    email: support@roostedhr.com
  description: |-
    Enterprise API

    Sandbox keys and Production keys are requested from support
servers:
  - url: https://api.roostedhr.com/api/1_12
  - url: https://sandbox.roostedhr.com/api/1_12
security:
  - X-API-KEY: []
tags:
  - name: Announcements
  - name: Areas
  - name: Clients
  - name: Company
  - name: Configuration
  - name: Events
  - name: Locations
  - name: Payroll Groups
  - name: Rate Cards
  - name: Shifts
  - name: Skillsets
  - name: Time Tracking
  - name: Wage Rules
  - name: Workers
paths:
  /workers/{id}/credentials/{credentials_id}:
    parameters:
      - schema:
          type: string
        name: id
        in: path
        required: true
        description: Worker ID
      - schema:
          type: string
        name: credentials_id
        in: path
        required: true
        description: Credentials ID
    get:
      tags:
        - Workers
      summary: Get Worker Credential
      description: Returns a single credential record for a specific worker.
      operationId: get-worker-credential
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkerCredential'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                    description: Machine-readable error code.
                  error:
                    type: string
                    description: Human-readable error message.
              examples:
                Invalid page parameter:
                  value:
                    code: WRK-2400
                    error: Invalid page parameter
                Invalid items per page parameter:
                  value:
                    code: WRK-2400
                    error: Invalid items per page parameter
                Invalid date range filter:
                  value:
                    code: WRK-2400
                    error: Invalid date range filter
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                    example: ATH-100
                  error:
                    type: string
                    example: Invalid or missing API key.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                    example: WRK-800
                  error:
                    type: string
                    example: Insufficient permissions to manage workers.
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                    example: WRK-1600
                  error:
                    type: string
                    example: Credential not found.
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                    example: WRK-900
                  error:
                    type: string
                    example: An unexpected error occurred.
components:
  schemas:
    WorkerCredential:
      type: object
      description: A credential record assigned to a worker.
      properties:
        id:
          type: string
          description: Personnel credential record identifier.
        personnel_id:
          type: integer
          description: Worker personnel ID.
        credentials_id:
          type: string
          description: Credential definition ID.
        submitter_id:
          type: integer
          description: ID of the user who submitted the credential.
        submitter_name:
          type: string
          description: Name of the user who submitted the credential.
        date_completed:
          type: string
          nullable: true
          description: Completion date (e.g. "2023-12-03 20:00:00"). `null` if not set.
        date_completed_nice:
          type: string
          nullable: true
          description: Formatted completion date (e.g. "Dec 3rd, 2023"). `null` if not set.
        date_expired:
          type: string
          nullable: true
          description: Expiration date (e.g. "2023-12-04 20:00:00"). `null` if not set.
        date_expired_nice:
          type: string
          nullable: true
          description: Formatted expiration date (e.g. "Dec 4th, 2023"). `null` if not set.
        date_submitted:
          type: string
          description: Submission timestamp.
        date_submitted_nice:
          type: string
          description: Formatted submission date.
        file_location_value:
          type: string
          nullable: true
          description: URL to the uploaded credential file. `null` if no file attached.
        file_name:
          type: string
          nullable: true
          description: Original file name.
        file_display_name:
          type: string
          nullable: true
          description: Display file name.
        clients_id:
          type: string
          nullable: true
          description: Associated client ID. `null` for general credentials.
        client_name:
          type: string
          nullable: true
          description: Associated client name.
        locations_id:
          type: string
          nullable: true
          description: Associated location/venue ID. `null` for general credentials.
        location_name:
          type: string
          nullable: true
          description: Associated location/venue name.
        deleted:
          type: integer
          enum:
            - 0
            - 1
          description: Soft-delete flag. `0` = active, `1` = deleted.
        company_id:
          type: integer
          description: Company ID.
        name:
          type: string
          description: Credential name.
        description:
          type: string
          description: Credential description.
        expiring_inform:
          type: integer
          enum:
            - 0
            - 1
          description: Whether to notify worker before expiry. `1` = yes, `0` = no.
        expiring_inform_period:
          type: integer
          description: Days before expiry to notify the worker.
        expiring_inform_hr:
          type: integer
          enum:
            - 0
            - 1
          description: Whether to notify HR before expiry. `1` = yes, `0` = no.
        expiring_inform_hr_period:
          type: integer
          description: Days before expiry to notify HR.
        expired_inform:
          type: integer
          enum:
            - 0
            - 1
          description: Whether to notify worker on expiry. `1` = yes, `0` = no.
        expired_inform_hr:
          type: integer
          enum:
            - 0
            - 1
          description: Whether to notify HR on expiry. `1` = yes, `0` = no.
        rule_usable:
          type: integer
          enum:
            - 0
            - 1
          description: >-
            Whether the credential can be used in matching rules. `1` = yes, `0`
            = no.
        worker_viewable:
          type: integer
          enum:
            - 0
            - 1
          description: >-
            Whether the worker can view this credential. `1` = viewable, `0` =
            hidden.
        worker_editable:
          type: integer
          enum:
            - 0
            - 1
          description: >-
            Whether the worker can edit this credential. `1` = editable, `0` =
            read-only.
        type:
          type: string
          enum:
            - General
            - Client
            - Venue
          description: Credential type.
        protected:
          type: integer
          enum:
            - 0
            - 1
          description: >-
            Whether the credential is protected from deletion. `1` = protected,
            `0` = not protected.
        course_id:
          type: integer
          nullable: true
          description: Associated course ID. `null` if not linked to a course.
        expiration_months:
          type: integer
          nullable: true
          description: Number of months until auto-expiry. `null` if no auto-expiry.
  securitySchemes:
    X-API-KEY:
      name: X-API-KEY
      type: apiKey
      in: header

````