List supplier letter templates and their placeholders (any role)

GET

/recovery-templates

const url = 'https://api.invogi.com/v1/recovery-templates';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.invogi.com/v1/recovery-templates \
  --header 'Authorization: Bearer <token>'

Built-in letters (ids builtin:CLAIM, builtin:FOLLOW_UP, builtin:FINAL_REMINDER, builtin:STATEMENT_REQUEST) first, then the workspace’s own. Claim, follow-up and final-reminder letters are used by /recoveries/{caseId}/claim-pack and take placeholders; statement request letters are used by /statement-requests and take statementRequestPlaceholders. Placeholders such as {{amount}} are filled when a letter is prepared.

Authorizations

bearerAuth

Responses

200

Templates

application/json

object

items

Array<object>

object

required

Builtin: for a built-in, otherwise a uuid

string

name

required

string

purpose

required

string

Allowed values: CLAIM FOLLOW_UP FINAL_REMINDER STATEMENT_REQUEST

subject

required

string

body

required

string

builtIn

required

boolean

description

string | null

updatedAt

string | null format: date-time

placeholders

Array<object>

object

name

string

description

string

statementRequestPlaceholders

Array<object>

object

name

string

description

string

Example

{
  "items": [
    {
      "purpose": "CLAIM"
    }
  ]
}