Gamma API
ProjectsActivity

List project emails

GET
/api/projects/{projectId}/emails

Every mail the project sent or has queued — assignments, alone or in a digest, and invitations to it — newest first, a page at a time.

Who may call it: Whoever manages the project: an owner, security admin or admin of its organization, or an admin of the project. API keys: no.

Authorization

session
cookiegamma.session_token<token>

The session cookie a sign-in sets. Over HTTPS its name carries the __Secure- prefix. Browsers send it on their own; other clients keep it from the sign-in response.

Path Parameters

projectId*string

The project's id.

Query Parameters

page?integer
Range1 <= value <= 9007199254740991
Default1
pageSize?integer
Range1 <= value <= 100
Default50
type?string

A notification type, e.g. issue.assigned.

Length1 <= length
status?string
Value in"pending""sent""failed"
search?string

Part of the recipient's address, any case.

Length1 <= length <= 200
from?string

The first day, UTC, inclusive.

Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
Formatdate
to?string

The last day, UTC, inclusive.

Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
Formatdate

Response Body

OK.

application/json
  1. response
emails*array<>

Newest first.

total*integer
Range-9007199254740991 <= value <= 9007199254740991
page*integer
Range-9007199254740991 <= value <= 9007199254740991
pageSize*integer
Range-9007199254740991 <= value <= 9007199254740991
Example Request
curl -X GET 'http://localhost:3000/api/projects/string/emails'
Example Response
{  "emails": [    {      "id": "string",      "type": "string",      "recipientId": "string",      "recipientName": "string",      "email": "string",      "status": "pending",      "digest": true,      "dueAt": "2019-08-24T14:15:22Z",      "sentAt": "2019-08-24T14:15:22Z",      "lastError": "string",      "createdAt": "2019-08-24T14:15:22Z",      "actor": {        "id": "string",        "name": "string",        "image": "string"      },      "about": {        "kind": "issue",        "number": -9007199254740991,        "title": "string",        "role": "string"      }    }  ],  "total": -9007199254740991,  "page": -9007199254740991,  "pageSize": -9007199254740991}