List projects

GET

/v1/projects

const url = 'https://proficient-seahorse-829.eu-west-1.convex.site/v1/projects?limit=20&team_id=team_jn7fw41m8n5jtht7hxsy69tzg97gvef8&search=campaign&order=asc';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

curl --request GET \
  --url 'https://proficient-seahorse-829.eu-west-1.convex.site/v1/projects?limit=20&team_id=team_jn7fw41m8n5jtht7hxsy69tzg97gvef8&search=campaign&order=asc' \
  --header 'Authorization: Bearer <token>'

Lists a team’s projects, newest first.

Authorizations

apiKey

Parameters

Query Parameters

limit

How many to return. 1–60, 20 by default.

integer

>= 1 <= 60

Example

How many to return. 1–60, 20 by default.

cursor

The next_cursor of the previous page. Omit for the first page.

string

The next_cursor of the previous page. Omit for the first page.

team_id

required

The team whose projects to list.

string

>= 1 characters

Example

team_jn7fw41m8n5jtht7hxsy69tzg97gvef8

The team whose projects to list.

search

Filter by name. Matches are returned by relevance rather than by date.

string

Example

campaign

Filter by name. Matches are returned by relevance rather than by date.

order

Oldest or newest first. Newest by default, and ignored when search is set.

string

Allowed values: asc desc

Example

desc

Oldest or newest first. Newest by default, and ignored when search is set.

Responses

200

A page of projects

application/json

object

data

required

Array<object>

object

required

string

name

required

string

team

required

object

required

string

name

required

string

created_by

required

string | null

thumbnail_url

required

A signed, time-limited still of the project. Null until one has been rendered.

string | null

created_at

required

number

updated_at

required

number | null

has_more

required

Whether another page follows.

boolean

next_cursor

required

Pass as cursor to read the next page. Null on the last page.

string | null

Example

{
  "data": [
    {
      "id": "proj_jd71dcg41pjy7rax1v2h4pvcmd7gtar9",
      "name": "Summer campaign",
      "team": {
        "id": "team_jn7fw41m8n5jtht7hxsy69tzg97gvef8",
        "name": "Brand team"
      },
      "created_by": "user_k970b359khfwwny0q8fjah1hc97gtcwm",
      "created_at": 1748875980,
      "updated_at": 1748875986
    }
  ],
  "has_more": false
}

404

Team not found

application/json

object

error

required

string

Example

{
  "error": "Render not found"
}