---
updatedAt: 2026-07-10T20:35:12.000Z
agentTools:
  projectIndex: https://developer.greatquestion.co/llms.txt
---

# Add study participants

Adds candidates to a study as shortlisted participants. Skips candidates that are ineligible, uncontactable, inaccessible to the caller, or already participating.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "API Reference (V1)",
    "version": "v1"
  },
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "components": {
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    },
    "schemas": {
      "error": {
        "type": "object",
        "properties": {
          "error": {
            "type": "string",
            "description": "Why the request was rejected."
          }
        },
        "required": [
          "error"
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://{defaultHost}",
      "variables": {
        "defaultHost": {
          "default": "api.greatquestion.co"
        }
      }
    }
  ],
  "paths": {
    "/v1/studies/{study_id}/participants": {
      "post": {
        "summary": "Add study participants",
        "tags": [
          "Studies"
        ],
        "description": "Adds candidates to a study as shortlisted participants. Skips candidates that are ineligible, uncontactable, inaccessible to the caller, or already participating.",
        "operationId": "addStudyParticipants",
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "parameters": [
          {
            "name": "study_id",
            "in": "path",
            "description": "Study ID",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "201": {
            "description": "created",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "added": {
                          "type": "integer"
                        },
                        "already_participating": {
                          "type": "integer"
                        },
                        "skipped_inaccessible": {
                          "type": "integer"
                        },
                        "skipped_uncontactable": {
                          "type": "integer"
                        },
                        "skipped_ineligible": {
                          "type": "integer"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "study in another account"
          },
          "422": {
            "description": "candidate_ids missing",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/error"
                }
              }
            }
          }
        },
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "candidate_ids": {
                    "type": "array",
                    "items": {
                      "type": "integer"
                    },
                    "description": "IDs of existing candidates to add as shortlisted participants"
                  }
                },
                "required": [
                  "candidate_ids"
                ]
              }
            }
          },
          "required": true
        }
      }
    }
  }
}
```