Get a template

GET

/v1/templates/{id}

curl --request GET \
  --url https://shareout.site/v1/templates/example \
  --header 'Authorization: Bearer <token>'

• Production

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string

Responses

200

The template

Media typeapplication/json

object

id

string

artifact_id

string | null

owner_id

string

name

string

subject

string

html

string

text_body

string

is_system

boolean

created_at

integer

updated_at

integer

Example^generated

{
  "id": "example",
  "artifact_id": "example",
  "owner_id": "example",
  "name": "example",
  "subject": "example",
  "html": "example",
  "text_body": "example",
  "is_system": true,
  "created_at": 1,
  "updated_at": 1
}

404

Resource not found

Media typeapplication/json

object

success

required

boolean

error

required

Human-readable message.

string

code

required

Machine-readable error code.

string

request_id

Correlation id (also the X-Request-Id header). Quote it in support tickets.

string

reason

Finer cause under code. For UNAUTHORIZED: missing, invalid, revoked or expired.

string

hint

What to do next, in plain words.

string

suggestion

string

param

The request field at fault.

string

docs

Doc page for this error.

string

redirect_url

string

support

Present on 5xx — how to reach a human.

object

how

string

include

Array<string>

Example

{
  "success": false,
  "support": {
    "how": "POST /v1/support/tickets",
    "include": [
      "request_id"
    ]
  }
}