account.me

The account behind this credential

GET/account

Operation: account.me
MCP tool: account_me

Who this credential acts for, and the account's video-time balance. The fields an integration needs, not the whole account record.

curl 'https://api.gogoscreen.com/api/v1/account' \
  -H "Authorization: Bearer $GOGOSCREEN_API_KEY"

A request to this operation.

json

{
  "account": {
    "id": "3f2b0c1a-9d4e-4a61-b8c2-000000000001",
    "email": "docs-funded-d81d104d@docs.local",
    "name": "Docs examples",
    "emailVerified": true,
    "role": "user",
    "createdAt": "2026-09-21T11:00:00.000Z",
    "deletionStatus": "active"
  },
  "wallet": {
    "planSeconds": 0,
    "planId": null,
    "planExpiresAt": null,
    "planActive": false,
    "paygSeconds": 542,
    "freeSeconds": 0,
    "reservedSeconds": 0,
    "availableSeconds": 542
  },
  "credential": {
    "kind": "api_key",
    "apiKeyId": "3f2b0c1a-9d4e-4a61-b8c2-000000000002",
    "scopes": [
      "account:read",
      "catalog:read",
      "marketing:export",
      "marketing:read",
      "marketing:write",
      "renders:read",
      "renders:write",
      "storyboards:read",
      "storyboards:write",
      "usage:read",
      "wallet:read",
      "webhooks:manage"
    ]
  }
}

200 response, captured from a real call. Ids, timestamps and signed URLs are replaced; the shape is untouched.

At a glance

Fact	Detail
Scopes	`account: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	`account_me`
Always sets	`Cache-Control: private, no-store`

Response

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

200 OK

The account behind this credential

200 OK body

Name

Type

Description

account

object

7 fields inside account

Name	Type	Description
createdAt	string \| null	format: date-time
deletionStatus	string \| null
email	string
emailVerified	boolean	Read from the credential, which is the authority on verification.
id	string
name	string \| null
role	string \| null

credential

object

apiKeyId

string | null

kind

string

one of: user, api_key

scopes

string[] | null

null means a user credential, which carries every scope.

wallet

object | null

null only when the balance could not be read; a status question never fails on the wallet.

8 fields inside wallet

Name	Type	Description
availableSeconds	number	What a new render or export may be reserved against, right now.
freeSeconds	number
paygSeconds	number
planActive	boolean
planExpiresAt	string \| null	format: date-time
planId	string \| null
planSeconds	number
reservedSeconds	number

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.