Get an agent

GET

/api/v3/agents/{agentUuid}

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

Authorizations

bearerAuth

Parameters

Path Parameters

agentUuid

required

string

The agent’s unique identifier.

Query Parameters

api

required

boolean

Required. Set to true.

Responses

200

200 OK

application/json

object

items

object

uniqueId

string

name

string

type

integer

guidelines

string

status

integer

runMode

string

frequency

string

nullable

validationCode

string

nullable

lastRunAt

string

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"
  },
  "message": "Agent retrieved.",
  "total": 1
}

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