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 Account API
version: 1.0.0
description: 'Operations tagged Sue Account across 2 of this provider''s published API definitions: connections-icu-accounts-openapi-original.json, connections-icu-accounts-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://accounts.connectionsapi.com
tags:
- name: Sue Account
paths:
/v1/sue-account:
get:
operationId: accounts_get_sue_account
summary: Read whether one Sue account exists and whether its deletion was requested
description: 'For the Sue reaper only. Answers { exists, deletionRequestedAt } for one Sue-shaped address and nothing more. Every other address is refused with 400. Requires a Connections admin: an API key or a session, never an OAuth app.'
parameters:
- name: address
in: query
required: true
schema:
type: string
description: The Sue address.
responses:
'200':
description: Whether the Sue account exists, and when its owner asked to be deleted (null if not).
content:
application/json:
schema:
type: object
required:
- exists
- deletionRequestedAt
properties:
exists:
type: boolean
deletionRequestedAt:
type:
- string
- 'null'
format: date-time
'400':
description: The address is not a Sue address.
content:
application/json:
schema:
type: object
'401':
description: Missing or invalid credential.
content:
application/json:
schema:
type: object
'403':
description: The caller is not a Connections admin, or is an OAuth app.
content:
application/json:
schema:
type: object
security:
- ApiKey: []
tags:
- Sue Account
servers:
- url: https://accounts.connectionsapi.com
components:
securitySchemes:
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
cnxKey:
type: http
scheme: bearer
description: A cnx_live_ key minted in Studio. It acts as the member who minted it, within its scopes.
x-connections-credential: connections-key
BearerAuth:
type: http
scheme: bearer
description: 'The member''s AEGIS session access token - the same bearer every other accounts.connections member route accepts (Authorization: Bearer <token>). Only the three member twins (profile, addresses, time zone) also take a scoped cnx_live_ key, under the cnxKey scheme.'
x-connections-credential: member-session
ApiKey:
type: http
scheme: bearer
description: A Connections admin's API key or session token, for the Sue reaper's identity read only.
x-connections-credential: connections-key
x-refined-from:
- connections-icu-accounts-openapi-original.json
- connections-icu-accounts-openapi.yml