Skip to main content
GET
/
v1
/
projects
List Projects
curl --request GET \
  --url https://api.example.com/v1/projects \
  --header 'x-api-key: <api-key>' \
  --header 'x-selected-account-id: <api-key>'
{
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "active",
      "created_at": "2023-11-07T05:31:56Z",
      "configuration": {
        "retention": {
          "files": "<string>",
          "result_artifacts": "<string>"
        }
      },
      "archived_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total_count": 123,
  "next_token": "<string>",
  "prev_token": "<string>"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication

​
x-selected-account-id
string
header
required

Selected Account ID

Query Parameters

​
include_archived
boolean
default:false
​
page_size
integer | null

Number of items per page

Required range: 1 <= x <= 100
​
sort_by
string | null

Field to sort by

​
sort_order
enum<string> | null

Sort order (asc or desc) Enum for project sort fields. Note that only non-nullable fields can be sorted by (for details, see: https://github.com/djrobstep/sqlakeyset?tab=readme-ov-file#limitations ).

Available options:
asc,
desc
​
continuation_token
string | null

Pagination token

​
ids
string[] | null

Filter by project IDs

​
statuses
enum<string>[] | null

Filter by project statuses (active, archived)

Enum for project status values.

Available options:
active,
archived
​
created_at_start
string<date-time> | null

Filter by creation time (start)

​
created_at_end
string<date-time> | null

Filter by creation time (end)

​
name
string | null

Filter by project name (case-insensitive partial match)

Response

Successful Response

​
items
ProjectEntity · object[]
required
​
total_count
integer
required
​
next_token
string | null
​
prev_token
string | null