Sign in
latestOpenAPI 3.0.12026-08-16171142480.4 KB

ff1699330afa

Account Template API

Get a single account template with its full payload

get/rest/api/v1/projects/{projectId}/templates/{templateId}

Path parameters

projectIdstring uuid required
templateIdstring uuid required

Response

OK

attentionReasonstring

Short human-readable explanation of why needsAttention is set.

blocksstring[]

Content blocks this template carries.

compatibilitystring

Payload compatibility marker: CURRENT, AUTO_MIGRATED, or REVIEW_NEEDED.

createdstring date-time
createdBystring
descriptionstring
expectedRevisioninteger

Required on update. The server compares this against the current revision and returns HTTP 409 on mismatch.

idstring uuid
linkedCountinteger

Number of accounts currently linked to this template.

metadataUpdatedstring date-time
namestring required

Display name. Must be unique per project (case-insensitive).

needsAttentionboolean

True if this template references resources that no longer exist (for example, a deleted source account or strategy).

payloadJsonNode required

Full template payload. Includes a schemaVersion discriminator describing its JSON shape; older versions are migrated transparently on read.

projectIdstring uuid required

Project this template belongs to. Set from the URL path; any value in the body is ignored.

referenceAccountIdstring uuid

Account that was used as the source when this template was created. Helps clients resolve symbol references in the payload.

revisioninteger

Current revision number. Bumped only when the payload actually changes.

updatedstring date-time
updatedBystring