Skip to main content
GET
/
trials
Get Trials
curl --request GET \
  --url https://newleaf-api-336813653216.us-central1.run.app/external/v1/trials/ \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "is_active": true,
    "is_archived": true,
    "description": "<string>",
    "external_id": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "instructions": "<string>",
    "start_date": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
Authorization
string
header
required

OAuth 2.0 Client Credentials Grant. Requires client_id and client_secret to obtain a Bearer token.

Query Parameters

​
active
boolean

Filter by active status.

​
archived
boolean
default:false

Filter by archived status. If not provided, defaults to False (unarchived trials are returned).

Response

A list of trials.

​
id
string<uuid>
required

Unique identifier for the project/trial.

​
name
string
required

Name of the project/trial.

​
organization_id
string<uuid>
required

Identifier of the organization this project/trial belongs to.

​
created_by
string<uuid>
required

Identifier of the user who created the project/trial.

​
created_at
string<date-time>
required

Timestamp of when the project/trial was created.

​
is_active
boolean
required

Indicates if the project/trial is currently active.

​
is_archived
boolean
required

Indicates if the project/trial is archived.

​
description
string | null

Optional description of the project/trial.

​
external_id
string | null

Optional external identifier for the project/trial.

​
updated_at
string<date-time> | null

Timestamp of when the project/trial was last updated.

​
instructions
string | null

Optional instructions for the project/trial.

​
start_date
string<date-time> | null

Optional start date of the project/trial.