Capability Sources

List or search Gmail messages as the calling member

Changed on

Reads and searches inbox mail in the calling member's Gmail mailbox, using the Google account they connected through the org Google Workspace connection. Returns needs_connection when the member has not connected their Google account yet or the connection lacks Gmail read permission.

get/v1/capabilities/google-workspace/gmail-messages

Request

  • Base URL: https://api.openworklabs.com
  • URL: https://api.openworklabs.com/v1/capabilities/google-workspace/gmail-messages
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Query parameters

qstring

Optional Gmail search query, using Gmail's search syntax.

maxResultsinteger

Maximum messages to return, capped at 25.

pageTokenstring

nextPageToken from a previous page of the same Gmail search.

Response

Gmail messages returned.

oktrue required
nextPageTokenstring

Changes

  • bb8ff73e4ad3Revision changes
    • info

      the endpoint scheme security bearerAuth was added to the API

    • info

      the endpoint scheme security denApiKey was added to the API

  • 7d79c843d137Revision changes
    • info

      added the new optional query request parameter pageToken

    • info

      added the optional property to the response with the status