Communications

GET /v1/email/drafts

GET /v1/email/drafts

Required scopes: communications:read

get/v1/email/drafts

Request

  • Base URL: https://api.yardstick.team
  • URL: https://api.yardstick.team/v1/email/drafts
  • Auth: HTTP bearer

Query parameters

limitinteger

Page size (1-100, default 20).

starting_afterstring

Cursor: id of the last record from the previous page.

status'pending_review' | 'approved' | 'send_reserved' | 'sent' | 'discarded' | 'not_delivered' | 'delivery_unconfirmed'

Repeatable or comma-separated. Restricts results to matching draft statuses.

email_typestring

Repeatable or comma-separated. Restricts results to matching candidate email types.

Headers

X-Request-Idstring

Optional caller-supplied request identifier. Values must match ^[A-Za-z0-9_-]{1,128}$; a valid value is echoed in the response X-Request-Id header, otherwise the API generates one.

Response

Success

object'list' required
has_moreboolean required

Changes

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