---
title: "Get Invite Template"
method: GET
path: "/inviteTemplates/{id}"
tags: ["Invite Templates"]
---

# Get Invite Template

`GET /inviteTemplates/{id}`

Get invite template.

## Response `200`

OK

- InviteTemplateGetResponse
  - `code` 'OK' | 'CREATED' | 'INVALID_CREDENTIALS' | 'INVALID_PARAMETERS' | 'INVALID_TOKEN' | 'UNAUTHORIZED_ACCESS' | 'MISSING_RESOURCE' | 'REQUEST_LIMIT_EXCEEDED' | 'SERVER_ERROR' | 'UNSUPPORTED_METHOD' | 'SERVER_UNAVAILABLE' | 'TIME_LIMIT_EXCEEDED' — Request status code
  - `message` string — Message response to the request
  - `requestId` string — Unique ID that is added to the body of every response for easy traceability of the request in our logs.
  - `data` InviteTemplate — Template to be used for sending invites.
    - `id` string, required — Unique ID of this object
    - `name` string, required — Template name
    - `company` object, required
      - `name` string, required — Company name that it will appear in the invite landing page and any invitation message
      - `logoUrl` string, required — Company logo that will appear in the invite email and landing page
    - `email` object, required
      - `sendEmail` boolean, required — Send email using this template (boolean value: true/false)
      - `senderName` string, required — Sender name that it will appear in the email message
      - `replyAddress` string, email, required — Reply-to address that will be shown when replying to an invite email
      - `subject` string, required — Subject that it will appear in the email message
      - `body` string, required — Text that it will appear in email message
    - `landingPage` object, required
      - `header` string, required — Header text that will appear in the landing page
      - `description` string, required — Description of the landing page
      - `button` string, required — Text that it will appear in the landing page
    - `successPage` object, required
      - `header` string, required — Header text that will appear in the success page
      - `description` string, required — Description of the success page after an account has been linked or data has been uploaded
      - `button` string, required — Text that it will appear in the landing page

---

[API](https://skmtc.net/smileapi/apis/smile-api.md) · [All operations](https://skmtc.net/smileapi/apis/smile-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/smileapi/smile-api/versions/d1e0cb5dc33c/schema)