Skip to main content
GET
/
api
/
projects
List Projects
curl --request GET \
  --url https://api.example.com/api/projects \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "settings": {},
      "dataset_ids": [],
      "owner_id": 123,
      "permissions": {
        "view": {
          "users": [
            123
          ],
          "roles": [
            "<string>"
          ]
        },
        "edit": {
          "users": [
            123
          ],
          "roles": [
            "<string>"
          ]
        }
      },
      "can_edit": false,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "page": 123,
  "per_page": 123,
  "total_pages": 123
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-API-Key
string | null

Query Parameters

q
string | null
page
integer
default:1
Required range: x >= 1
per_page
integer
default:20
Required range: 1 <= x <= 200

Cookies

antidote_session
string | null

Response

Successful Response

data
ProjectRead · object[]
required
total
integer
required
page
integer
required
per_page
integer
required
total_pages
integer
required