{
  "opencollection": "1.0.0",
  "info": {
    "name": "API Reference aiTaskBuilder credentials API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "credentials",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List credential pools for a workspace",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.prolific.com/api/v1/credentials/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "workspace_id",
                "value": "",
                "type": "query",
                "description": "The workspace ID to filter credential pools by"
              }
            ]
          },
          "docs": "Retrieve a list of credential pools belonging to a specific workspace.\nEach credential pool summary includes the pool ID, total number of credentials, number of available (unredeemed) credentials, and the workspace ID."
        },
        {
          "info": {
            "name": "Create credential pool",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.prolific.com/api/v1/credentials/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new workspace-level credential pool. Credential pools contain username/password pairs that can be assigned to participants when they start a study. This allows researchers to provide pre-provisioned credentials for third-party platforms.\nThe credentials are provided as a CSV string where each line contains a username and password separated by a comma (e.g., \"user1,pass1\\nuser2,pass2\")."
        },
        {
          "info": {
            "name": "Update credential pool",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.prolific.com/api/v1/credentials/:credential_pool_id/",
            "headers": [
              {
                "name": "Authorization",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "credential_pool_id",
                "value": "",
                "type": "path",
                "description": "Credential pool ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add new credentials to an existing credential pool. This operation is additive - new credentials are appended to the existing pool rather than replacing them. The credentials service validates that no duplicate usernames exist.\nThe credentials are provided as a CSV string where each line contains a username and password separated by a comma (e.g., \"user4,pass4\\nuser5,pass5\")."
        }
      ]
    }
  ],
  "bundled": true
}