marketing.projects.get

One marketing project

GET/marketing/projects/{id}

Operation: marketing.projects.get
MCP tool: marketing_projects_get

The whole editor read for one project: the project row, its current revision (scenes, copy, music, timing), the state of its source and which slots still need a picture, the template at the version THIS project records — never the catalogue's newest — the music credit, and its exports newest first.

curl -X GET "https://api.gogoscreen.com/api/v1/marketing/projects/<id>" \
  -H "Authorization: Bearer $GOGOSCREEN_API_KEY"

A request to this operation.

At a glance

Fact	Detail
Scopes	`marketing:read`
Credentials	a signed in dashboard session or an API key.
Rate limit	600 requests a minute per credential, in the `read` class.
Idempotency	Not applicable. This operation changes nothing.
MCP tool	`marketing_projects_get`
Always sets	`Cache-Control: private, no-store`
Verified email	Required. An account whose email address is not verified meets `403 email_unverified` before the operation runs.

Path parameters

Name	Type	Required	Description
id	string	Required	The resource `id`, from a create answer or the matching list.format: uuid

Response

Answers 200. Every answer also carries RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset, and every error body carries a requestId.

200 OK

One marketing project

200 OK body

Name

Type

Description

credit

object | null

The music credit this revision's bed owes. Open shape, may gain keys; ≤65536 bytes, ≤16 deep.any keys

exports

object[]

string

state

string

status

string

narration

object | null

Whether this deployment can speak a written narration, and the sentence when it cannot. Open shape, may gain keys; ≤65536 bytes, ≤16 deep.any keys

preview

object | null

What a preview of the current revision would play. Open shape, may gain keys; ≤65536 bytes, ≤16 deep.any keys

project

object

11 fields inside project

Name	Type	Description
createdAt	string \| null	format: date-time
currentRevisionId	string \| null
id	string
marketingSourceId	string \| null
sourceKind	string	one of: walkthrough, website
sourceRenderId	string \| null
status	string
templateId	string
templateVersion	string
title	string
updatedAt	string \| null	format: date-time

revision

object | null

9 fields inside revision

Name	Type	Description
createdAt	string \| null	format: date-time
document	object	The revision's own document: the scenes, the copy, the music and the timing. Open shape, may gain keys; ≤65536 bytes, ≤16 deep.any keys
id	string
locks	object	The parts of this revision the customer has locked. Open shape, may gain keys; ≤65536 bytes, ≤16 deep.any keys
number	number
parentRevisionId	string \| null
projectId	string
restoredFromRevisionId	string \| null
seed	number

slots

object[]

The picture slots of the design and what each could be filled with.

source

object | null

The state of what the project is made from. Open shape, may gain keys; ≤65536 bytes, ≤16 deep.any keys

template

object | null

The template at the version this project records. Open shape, may gain keys; ≤65536 bytes, ≤16 deep.any keys

200 OK headers
Header	Meaning
`Cache-Control`	Always `private, no-store`.

Errors

Every refusal is { error: { code, message, details?, requestId } }. Branch on code, never on the sentence. The full catalogue is at Errors.

Code	Status	When it happens	What to do
validation_failed	400	The merged path, query and body did not match the operation's schema. The schemas are strict, so an unknown field is a failure rather than something ignored, and a string carrying half of a character is refused before it can be stored.	Read `details.issues`. Each entry carries a `path`, a `message` and a machine readable `code`. Fix every named field and send the request again; the same body always fails the same way.
unauthorized	401	No credential was presented, or the key is unknown, revoked or expired, or an `X-API-Key` header carried something that is not an API key. `details.reason` says which.	Send `Authorization: Bearer gsk_live_…`. A revoked or expired key never starts working again, so issue a new one in the developer console. Put a dashboard session token in `Authorization`, never in `X-API-Key`.
forbidden_scope	403	The credential does not carry every scope the operation declares, or it is the wrong kind of credential for it. `keys.` and `assistant.` are user only and can never be called by a key.	`details.requiredScopes` and `details.missingScopes` name what is missing. A key's scopes cannot be changed after it is issued, so create a new key with them. When `details.allowedActors` is present, no key can call this operation at all.
not_found	404	No resource of that id belongs to this account. A resource that belongs to somebody else answers 404 as well, never 403.	Check the id. Do not treat this as a permissions problem.
rate_limited	429	The credential's per minute budget, the account's per minute ceiling, or a daily cap was exceeded. `details.scope` is `minute`, `day` or `account`, or `global` when the product's own daily cap on voice previews is spent.	Wait the `Retry-After` seconds and retry. `details.limit` and `details.resetAt` say what was hit and when it reopens. The `RateLimit-*` headers on every answer let a client pace itself before it gets here.
internal_error	500	An unhandled failure inside this API. The original message is logged and never answered.	Retry once, then quote `requestId` to support. A 5xx deletes the idempotency claim rather than storing it, so retrying under the same key is safe.