Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Connections Icu Sue Mail API
version: 1.0.0
description: 'Operations tagged Sue Mail across 2 of this provider''s published API definitions: connections-icu-product-openapi-original.json, connections-icu-product-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.connectionsapi.com/v1
security:
- ApiKey: []
- OAuth2: []
tags:
- name: Sue Mail
paths:
/sue-mail:
get:
summary: Read a Sue's mail
description: The mail delivered to one Sue (a SUE simulated user, sue---@connections.icu) in the window, oldest first. Every other address is refused. Requires a Connections admin.
parameters:
- name: address
in: query
required: true
schema:
type: string
description: The Sue address.
- name: since
in: query
required: false
schema:
type: string
format: date-time
description: 'Only mail received after this instant. Default: the last day; never older than the landing keeps mail.'
responses:
'200':
description: The Sue's messages.
content:
application/json:
schema:
type: object
required:
- address
- messages
properties:
address:
type: string
messages:
type: array
items:
type: object
required:
- messageId
- from
- subject
- text
- html
- receivedAt
- deliveredAt
properties:
messageId:
type: string
description: The SES message id.
from:
type: string
subject:
type: string
text:
type: string
description: The plain-text part, or the html part with its tags stripped.
html:
type:
- string
- 'null'
description: The html part exactly as sent, or null for a text-only message.
receivedAt:
type: string
format: date-time
description: The message's Date header.
deliveredAt:
type: string
format: date-time
description: When SES received it.
'400':
description: The address is not a Sue address.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Missing or invalid credential.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: The caller is not a Connections admin, or is an OAuth app.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- ApiKey: []
tags:
- Sue Mail
operationId: getSueMail
x-operation-id-source: derived
servers:
- url: https://api.connectionsapi.com/v1
components:
schemas:
ErrorResponse:
type: object
description: Standard error payload returned by the Connections Developer API.
required:
- error
properties:
error:
type: string
securitySchemes:
ApiKey:
type: http
scheme: bearer
description: Connections workspace API key.
x-connections-credential: connections-key
OAuth2:
type: http
scheme: bearer
description: Connections OAuth access token.
x-connections-credential: oauth-access-token
memberSession:
type: http
scheme: bearer
description: The member's Connections session access token, exactly as this product's app sends it. Only operations that declare this scheme accept one.
x-connections-credential: member-session
x-refined-from:
- connections-icu-product-openapi-original.json
- connections-icu-product-openapi.yml