People

The people on a letter

Everyone on it, 200 at a time: their id, name, company, address, your fields and, for a letter written for each person, their own letter (null while it’s still to write).

Permission: Read only.

get/v1/letters/{letter}/recipients

Request

  • Base URL: https://app.verygoodletter.co/api
  • URL: https://app.verygoodletter.co/api/v1/letters/{letter}/recipients
  • Auth: HTTP bearer

Path parameters

letterstring uuid required

The letter’s id, from Start a letter or Your letters.

Query parameters

offsetinteger

Where to start: next_offset from the last answer.

Response

What it did, as JSON, with the mode it ran in.

mode'sandbox' | 'live' required

Which the request ran in: the key’s.

Changes

No recorded changes to this operation across all 1 revision of this API.