# List all studies

GET https://api.prolific.com/api/v1/studies/

List all studies, with the option to filter by study status.

Reference: https://beta-docs.prolific.com/api-reference/studies/get-studies

## OpenAPI Specification

```yaml
openapi: 3.1.1
info:
  title: List all studies
  version: endpoint_studies.GetStudies
paths:
  /api/v1/studies/:
    get:
      operationId: get-studies
      summary: List all studies
      description: List all studies, with the option to filter by study status.
      tags:
        - - subpackage_studies
      parameters:
        - name: state
          in: query
          description: >-
            Filter studies by status. Accepts a string in the format
            "(active|published|...)", where "active" and "published" are example
            statuses.
          required: false
          schema:
            $ref: '#/components/schemas/ApiV1StudiesGetParametersState'
        - name: Authorization
          in: header
          description: Header authentication of the form `undefined <token>`
          required: true
          schema:
            type: string
      responses:
        '200':
          description: List of studies
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StudiesListResponse'
        '400':
          description: Error
          content: {}
components:
  schemas:
    ApiV1StudiesGetParametersState:
      type: string
      enum:
        - value: ACTIVE
        - value: PAUSED
        - value: UNPUBLISHED
        - value: PUBLISHING
        - value: COMPLETED
        - value: AWAITING REVIEW
        - value: UNKNOWN
        - value: SCHEDULED
    StudyShortStatus:
      type: string
      enum:
        - value: UNPUBLISHED
        - value: SCHEDULED
        - value: PUBLISHING
        - value: ACTIVE
        - value: AWAITING REVIEW
        - value: PAUSED
        - value: COMPLETED
    StudyShortStudyType:
      type: string
      enum:
        - value: SINGLE
        - value: UK_REP_SAMPLE
        - value: US_REP_SAMPLE
    StudyShort:
      type: object
      properties:
        id:
          type: string
          description: Study id. It is created by Prolific.
        name:
          type: string
          description: Public name or title of the study
        internal_name:
          type:
            - string
            - 'null'
          description: Internal name of the study, not shown to participants
        status:
          $ref: '#/components/schemas/StudyShortStatus'
          description: Status of the study.
        study_type:
          $ref: '#/components/schemas/StudyShortStudyType'
          description: Deprecated. Type of study.
        total_available_places:
          type: number
          format: double
          description: How many participants are you looking to recruit
        places_taken:
          type: number
          format: double
          description: >-
            Places already taken, number of submission started excluding timed
            out and returned submissions
        number_of_submissions:
          type: number
          format: double
        reward:
          type: number
          format: double
          description: >-
            How much are you going to pay the participants in cents. We use the
            currency of your account
        total_cost:
          type: number
          format: double
          description: Total cost of the study including fees
        published_at:
          type:
            - string
            - 'null'
          format: date-time
          description: Date time when the study was published.
        publish_at:
          type:
            - string
            - 'null'
          format: date-time
          description: Date time when the study was scheduled to be published.
        date_created:
          type: string
          format: date-time
          description: Date time when the study was created
        credential_pool_id:
          type:
            - string
            - 'null'
          description: The ID of the credential pool associated with this study, if any
      required:
        - id
        - name
    StudiesListResponse:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/StudyShort'
          description: List of all studies matching the criteria.
      required:
        - results

```

## SDK Code Examples

```python
import requests

url = "https://api.prolific.com/api/v1/studies/"

headers = {"Authorization": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.prolific.com/api/v1/studies/';
const options = {method: 'GET', headers: {Authorization: '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.prolific.com/api/v1/studies/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.prolific.com/api/v1/studies/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
HttpResponse<String> response = Unirest.get("https://api.prolific.com/api/v1/studies/")
  .header("Authorization", "<apiKey>")
  .asString();
```

```php
<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.prolific.com/api/v1/studies/', [
  'headers' => [
    'Authorization' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
var client = new RestClient("https://api.prolific.com/api/v1/studies/");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.prolific.com/api/v1/studies/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```