Get a project

GET

/v1/projects/{id}

const url = 'https://proficient-seahorse-829.eu-west-1.convex.site/v1/projects/proj_jd71dcg41pjy7rax1v2h4pvcmd7gtar9';
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/proj_jd71dcg41pjy7rax1v2h4pvcmd7gtar9 \
  --header 'Authorization: Bearer <token>'

Retrieves a single project.

Authorizations

apiKey

Parameters

Path Parameters

required

Project ID

string

>= 1 characters

Example

proj_jd71dcg41pjy7rax1v2h4pvcmd7gtar9

Project ID

Responses

200

The project

application/json

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

Example

{
  "id": "proj_jd71dcg41pjy7rax1v2h4pvcmd7gtar9",
  "name": "Summer campaign",
  "team": {
    "id": "team_jn7fw41m8n5jtht7hxsy69tzg97gvef8",
    "name": "Brand team"
  },
  "created_by": "user_k970b359khfwwny0q8fjah1hc97gtcwm",
  "created_at": 1748875980,
  "updated_at": 1748875986
}

404

Project not found

application/json

object

error

required

string

Example

{
  "error": "Render not found"
}