Sign in
latestOpenAPI 3.0.02026-08-1610635191.3 KB

355890b6b4cc

Projects

Get a specific project by ID

Retrieves a specific project by its ID. Only the project owner can access their projects.

get/projects/{id}

Path parameters

idstring required

Project ID (GUID)

Response

Project details

idstring

Unique identifier for the project (GUID)

namestring

Name of the project

descriptionstring

Detailed description of the project

urlstring

Optional URL associated with the project

tokenstring

Client token (owner of the project)

createdOnstring date-time

Creation timestamp

updatedOnstring date-time

Last update timestamp

activeboolean

Whether the project is active

imageUrlstring uri

Optional URL of the 200x50 brand image associated with the project

textColorstring nullable

Hex color (e.g.

backgroundColorstring nullable

Hex color (e.g.

brandColorstring nullable

Primary branding accent color applied to overlay shapes when branding is configured

accentColorstring nullable

Secondary accent color applied to overlay highlights and subtitles when branding is configured

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "AI Startup Launch",
  "description": "Building an AI-powered SaaS tool for content creators. Focus on automation, efficiency, and user experience.",
  "url": "https://example.com",
  "token": "abc123-def456-ghi789",
  "createdOn": "2024-01-01T12:00:00Z",
  "updatedOn": "2024-01-02T14:30:00Z",
  "active": true,
  "textColor": "#111827",
  "backgroundColor": "#F9FAFB",
  "brandColor": "#4338CA",
  "accentColor": "#7C72EF"
}