OAuth2 Applications

List Pub/Sub status

Lists Pub/Sub enabled OAuth2 applications and their subscription status

get/v1/pubsub/status

Request

  • Base URL: https://your-emailengine-host
  • URL: https://your-emailengine-host/v1/pubsub/status
  • Auth: HTTP bearer

Query parameters

pageinteger

Page number (zero indexed, so use 0 for first page)

pageSizeinteger

How many entries per page

Example:20

Headers

x-ee-timeoutinteger

Request timeout in milliseconds. Raises the command timeout above the EENGINE_TIMEOUT default for a long-running request; a value below the default has no effect

Example:30000

Response

Returns the Pub/Sub subscription state for each configured Gmail application.

totalinteger

How many matching entries

pageinteger

Current page (0-based index)

pagesinteger

Total page count

Example response

{
  "total": 120,
  "pages": 24,
  "apps": [
    {
      "id": "AAABhaBPHscAAAAH",
      "name": "My Gmail App",
      "lastError": {
        "response": "Enable the Cloud Pub/Sub API"
      },
      "pubSubError": {
        "message": "Failed to process subscription loop",
        "description": "Subscription not found"
      }
    }
  ]
}

Changes

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