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

# List Credential Kinds

> Retrieve a paginated list of credential kinds for your project.

<Info>
  **Permission Required**: `project:view-configs`
</Info>

Retrieve a paginated list of credential kinds for your project. The returned
`id` matches the `credential_kind_id` field on test player credentials, so
this endpoint is useful when constructing tests that reference credentials.

## Query Parameters

<ParamField query="page" type="integer" default="0">
  Page number (0-indexed)
</ParamField>

<ParamField query="page_size" type="integer" default="25">
  Results per page (1-100)
</ParamField>

## Response

<ResponseField name="data" type="CredentialKind[]" required>
  Array of credential kind objects
</ResponseField>

<ResponseField name="pagination" type="object" required>
  Pagination metadata (`page`, `page_size`, `total_count`, `total_pages`)
</ResponseField>

### CredentialKind Object

<ResponseField name="id" type="string" required>
  Credential kind ID (use as `credential_kind_id` on test player credentials)
</ResponseField>

<ResponseField name="name" type="string" required>
  Credential kind name
</ResponseField>

<ResponseField name="description" type="string">
  Optional description
</ResponseField>

<ResponseField name="exclusive" type="boolean" required>
  Whether each credential of this kind can be used by at most one concurrent run
</ResponseField>

<RequestExample>
  ```bash cURL theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
  curl -X GET "https://nunu.ai/api/v1/project/your-project-id/credential-kinds?page=0&page_size=25" \
    -H "X-Api-Key: YOUR_API_TOKEN"
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={"theme":{"light":"catppuccin-latte","dark":"catppuccin-mocha"}}
  {
    "data": [
      {
        "id": "ck_steam_account",
        "name": "Steam Account",
        "description": "Steam credentials",
        "exclusive": true
      }
    ],
    "pagination": {
      "page": 0,
      "page_size": 25,
      "total_count": 1,
      "total_pages": 1
    }
  }
  ```
</ResponseExample>


## OpenAPI

````yaml GET /project/{projectId}/credential-kinds
openapi: 3.1.0
info:
  title: nunu.ai API
  description: >-
    The nunu.ai Public API allows you to programmatically interact with your
    projects, manage test runs, and upload builds.
  version: 1.0.0
servers:
  - url: https://nunu.ai/api/v1
security:
  - apiKeyAuth: []
paths:
  /project/{projectId}/credential-kinds:
    parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
        description: >-
          The project ID. You can copy it from the project settings page or the
          project URL in the dashboard.
    get:
      tags:
        - Configs
      summary: List Credential Kinds
      description: Retrieve a paginated list of credential kinds for your project.
      operationId: listCredentialKinds
      parameters:
        - name: page
          in: query
          description: Page number (0-indexed)
          schema:
            type: integer
            default: 0
        - name: page_size
          in: query
          description: Results per page (1-100)
          schema:
            type: integer
            default: 25
            minimum: 1
            maximum: 100
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListCredentialKindsResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden - missing project:view-configs
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    ListCredentialKindsResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CredentialKind'
        pagination:
          $ref: '#/components/schemas/Pagination'
    Error:
      type: object
      properties:
        error:
          type: string
        code:
          type: string
        details:
          type: object
    CredentialKind:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
          nullable: true
        exclusive:
          type: boolean
    Pagination:
      type: object
      properties:
        page:
          type: integer
        page_size:
          type: integer
        total_count:
          type: integer
        total_pages:
          type: integer
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: API key for authentication

````