Projects

Get project by slug

Get a project by its slug.

get/teams/{team_id_or_slug}/projects/{project_slug}

Request

  • Base URL: https://api.convex.dev/v1
  • URL: https://api.convex.dev/v1/teams/{team_id_or_slug}/projects/{project_slug}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Path parameters

team_id_or_slugstring required

Team ID or slug

project_slugstring required

Project slug

Response

idinteger required
namestring required
slugstring required
teamIdinteger required
teamSlugstring required
createTimeinteger required

Timestamp in milliseconds.

prodDeploymentNamestring nullable

The name of the default production deployment for this project, if one exists (e.g. "happy-otter-123").

devDeploymentNamestring nullable

The name of the requesting member's default development deployment for this project, if one exists (an active local deployment or default cloud dev deployment).

Changes

No recorded changes to this operation across all 11 revisions of this API.