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. By signing up you are subscribing to the APIs.io and API Evangelist
newsletters — you can unsubscribe from any issue. See our
Privacy Policy and Terms.
openapi: 3.2.0
info:
description: The Relayger HTTP API. Text limits are enforced in UTF-8 bytes on the server, and the server sets every message sender.
title: Relayger OAuth API
version: 0.13.15
servers:
- url: https://relayger.com
security:
- bearerAuth: []
- sessionCookie: []
tags:
- name: OAuth
paths:
/v1/oauth/consent:
post:
operationId: post_v1_oauth_consent
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorConsent'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorRedirect'
description: Success; a change responds only after its transaction commits.
default:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Authorization, validation, conflict or server error
summary: A single-use consent decision bound to the browser.
tags:
- OAuth
components:
schemas:
ConnectorConsent:
additionalProperties: false
properties:
approve:
type: boolean
defaultIdentity:
format: uuid
type: string
identities:
items:
format: uuid
type: string
maxItems: 33
minItems: 1
type: array
request:
format: uuid
type: string
scopes:
items:
enum:
- relayger.read
- relayger.write
- relayger.contacts
- relayger.work
type: string
type: array
required:
- request
- approve
type: object
Error:
additionalProperties: false
properties:
error:
additionalProperties: false
properties:
code:
type: string
hint:
description: One English sentence with the next step, for codes that need one; act on code.
maxLength: 300
type: string
required:
- code
type: object
required:
- error
type: object
ConnectorRedirect:
additionalProperties: false
properties:
redirect:
format: uri
type: string
required:
- redirect
type: object
securitySchemes:
bearerAuth:
scheme: bearer
type: http
sessionCookie:
description: Valid for at most 8 hours, enforced by the database. Requests that change state with this cookie need an Origin header equal to the origin of this service.
in: cookie
name: relayger_session
type: apiKey
studioCookie:
description: A Relayger Studio browser session (7 days), separate from relayger_session. Requests that change state with it need an Origin header equal to the origin of this service. Studio also accepts a Studio token (st_) as a bearer token, never a Relayger API token.
in: cookie
name: relayger_studio
type: apiKey