List all agents

GET

/api/v3/agents

const url = 'https://api.tryletterhead.com/api/v3/agents?api=true';
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.tryletterhead.com/api/v3/agents?api=true' \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth

Parameters

Query Parameters

api

required

boolean

Required. Set to true.

Responses

200

200 OK

application/json

object

items

Array<object>

object

uniqueId

string

name

string

type

integer

guidelines

string

status

integer

runMode

string

frequency

string

nullable

validationCode

string

nullable

lastRunAt

string

nullable

channels

Array<string>

createdAt

string

updatedAt

string

message

string

total

integer

Example

{
  "items": [
    {
      "uniqueId": "mofuehvagv",
      "name": "House style checker",
      "type": 0,
      "guidelines": "> Check the draft against our house style guide.\n> - Use the serial comma.\n> - Spell out numbers under 10; use numerals for 10 and above.\n> - Em dashes take no surrounding spaces.\n>\n> Flag every violation with the specific line it appears on.",
      "status": 1,
      "runMode": "manual",
      "frequency": null,
      "validationCode": null,
      "lastRunAt": "2026-06-18T14:22:09+00:00",
      "channels": [
        "the-daily",
        "weekend-reads"
      ],
      "createdAt": "2026-04-11T10:05:33+00:00",
      "updatedAt": "2026-06-18T14:22:09+00:00"
    },
    {
      "uniqueId": "k2p8xrtnwq",
      "name": "Subject line reviewer",
      "type": 0,
      "guidelines": "> Review the subject line for clarity and length.\n> - Keep it under 60 characters.\n> - Avoid all caps and exclamation marks.",
      "status": 1,
      "runMode": "manual",
      "frequency": null,
      "validationCode": null,
      "lastRunAt": null,
      "channels": [
        "the-daily"
      ],
      "createdAt": "2026-04-11T10:05:33+00:00",
      "updatedAt": "2026-06-18T14:22:09+00:00"
    }
  ],
  "message": "Agents retrieved.",
  "total": 2
}

Still can’t find what you need? Contact support.