List emails | Tradespace | Developer Documentation

query ExampleQuery($agreementIds: [String!], $archived: ArchivedEnum, $contactIds: [String!], $createdOnMax: ISO8601Date, $createdOnMin: ISO8601Date, $dealIds: [String!], $disclosureIds: [String!], $filingIds: [String!], $from: String, $ideaIds: [String!], $limit: Int, $matterTypes: [String!], $opportunityIds: [String!], $page: Int, $q: String, $receivedAtMax: ISO8601Date, $receivedAtMin: ISO8601Date, $sortDirection: SortDirectionEnum, $sortField: String, $stateEnums: [IncomingEmailStateEnum!], $tagIds: [String!], $tagNames: [String!], $updatedOnMax: ISO8601Date, $updatedOnMin: ISO8601Date, $withoutContacts: Boolean) {
  incomingEmails(agreementIds: $agreementIds, archived: $archived, contactIds: $contactIds, createdOnMax: $createdOnMax, createdOnMin: $createdOnMin, dealIds: $dealIds, disclosureIds: $disclosureIds, filingIds: $filingIds, from: $from, ideaIds: $ideaIds, limit: $limit, matterTypes: $matterTypes, opportunityIds: $opportunityIds, page: $page, q: $q, receivedAtMax: $receivedAtMax, receivedAtMin: $receivedAtMin, sortDirection: $sortDirection, sortField: $sortField, stateEnums: $stateEnums, tagIds: $tagIds, tagNames: $tagNames, updatedOnMax: $updatedOnMax, updatedOnMin: $updatedOnMin, withoutContacts: $withoutContacts) {
    collection {
      aiSummary
      archivedAt
      archivedByUser
      createdAt
      htmlBody
      id
      incomingEmailAttachments
      incomingEmailAttachmentsCount
      incomingEmailContacts
      incomingEmailContactsCount
    }
    metadata {
      count
      currentPage
      extra
      hasNextPage
      hasPreviousPage
      limitValue
      nextPage
      previousPage
      totalCount
      totalPages
    }
  }
}

{
  "agreementIds": [
    "example"
  ],
  "archived": "EXCLUDE",
  "contactIds": [
    "example"
  ],
  "createdOnMax": "example",
  "createdOnMin": "example",
  "dealIds": [
    "example"
  ],
  "disclosureIds": [
    "example"
  ],
  "filingIds": [
    "example"
  ],
  "from": "example",
  "ideaIds": [
    "example"
  ],
  "limit": 0,
  "matterTypes": [
    "example"
  ],
  "opportunityIds": [
    "example"
  ],
  "page": 0,
  "q": "example",
  "receivedAtMax": "example",
  "receivedAtMin": "example",
  "sortDirection": "ASC",
  "sortField": "example",
  "stateEnums": [
    "assigned"
  ],
  "tagIds": [
    "example"
  ],
  "tagNames": [
    "example"
  ],
  "updatedOnMax": "example",
  "updatedOnMin": "example",
  "withoutContacts": true
}

{
  "data": {
    "incomingEmails": {
      "collection": [
        {
          "aiSummary": "example",
          "archivedAt": "example",
          "archivedByUser": {
            "avatarUrl": null,
            "contact": null,
            "createdAt": null,
            "email": null,
            "firstName": null,
            "fullName": null,
            "id": null,
            "lastName": null,
            "stateEnum": null,
            "updatedAt": null
          },
          "createdAt": "example",
          "htmlBody": "example",
          "id": "example",
          "incomingEmailAttachments": [
            {
              "byteSize": null,
              "contentDispositionEnum": null,
              "contentType": null,
              "createdAt": null,
              "filename": null,
              "id": null,
              "updatedAt": null,
              "url": null
            }
          ],
          "incomingEmailAttachmentsCount": 0,
          "incomingEmailContacts": [
            {
              "addressEnum": null,
              "contact": null,
              "createdAt": null,
              "createdByUser": null,
              "id": null,
              "stateEnum": null,
              "updatedAt": null
            }
          ],
          "incomingEmailContactsCount": 0
        }
      ],
      "metadata": {
        "count": 0,
        "currentPage": 0,
        "extra": {},
        "hasNextPage": true,
        "hasPreviousPage": true,
        "limitValue": 0,
        "nextPage": 0,
        "previousPage": 0,
        "totalCount": 0,
        "totalPages": 0
      }
    }
  }
}

Returns a paginated collection of incoming emails.

Arguments

agreementIdslist of StringsOptional

The IDs of the agreements linked to the records to return, including unconfirmed suggestions.

archivedArchivedEnumOptional

The archived state of the records to return. The default is EXCLUDE.

Allowed values:

contactIdslist of StringsOptional

The IDs of the contacts linked to the records to return. Matches emails linked to any of them.

createdOnMaxStringOptional

The latest creation date to return.

createdOnMinStringOptional

The earliest creation date to return.

dealIdslist of StringsOptional

The IDs of the deals linked to the records to return, including unconfirmed suggestions.

disclosureIdslist of StringsOptional

The IDs of the disclosures linked to the records to return, including unconfirmed suggestions.

filingIdslist of StringsOptional

The IDs of the filings linked to the records to return, including unconfirmed suggestions.

fromStringOptional

The sender address to match. Returns emails whose sender’s address contains this text, case-insensitively.

ideaIdslist of StringsOptional

The IDs of the ideas linked to the records to return, including unconfirmed suggestions.

limitIntegerOptional

The number of records returned. The default is 20, and the maximum is 500.

matterTypeslist of StringsOptional

The types of the matters linked to the records to return, such as Disclosure or Filing. Includes unconfirmed suggestions.

opportunityIdslist of StringsOptional

The IDs of the opportunities linked to the records to return, including unconfirmed suggestions.

pageIntegerOptional

The page number to return. Starts at 1.

qStringOptional

The text to search for. Matches title and text body.

receivedAtMaxStringOptional

The latest received date of the records to return.

receivedAtMinStringOptional

The earliest received date of the records to return.

sortDirectionSortDirectionEnumOptional

The sort direction. The default is DESC.

Allowed values:

sortFieldStringOptional

The field to sort by. One of received_at, title, created_at, and updated_at. The default is received_at.

stateEnumslist of IncomingEmailStateEnumsOptional

The states of the records to return.

Allowed values:

tagIdslist of StringsOptional

The IDs of the tags applied to the records to return. Matches emails with any of them.

tagNameslist of StringsOptional

The names of the tags applied to the records to return. Matches emails with any of them.

updatedOnMaxStringOptional

The latest last-updated date to return.

updatedOnMinStringOptional

The earliest last-updated date to return.

withoutContactsBooleanOptional

Whether to return only emails that have no linked contacts. Pass true to apply the filter.

Returns

an IncomingEmailCollection

collectionlist of IncomingEmails

A collection of paginated IncomingEmailCollection

metadataCollectionMetadata

Pagination Metadata for navigating the Pagination