An account corresponds to an email address, mailbox, and/or calendar. When connecting to the Aurinko API, a specific access token gives you access to a specific account’s data.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/aurinko:aurinko-account-api"curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a 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.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
contact:
email: support@aurinko.io
description: '## Introduction
The Aurinko API is a unified API platform allowing developers to quickly build integrations with
many mailbox providers and services like Google, Office 365, Outlook.com, MS Exchange, IMAP.
The unified API abstracts away differences between many email, calendar, contact, task APIs
to make it easy to connect and sync the mailbox data.
The Aurinko API''s focus is convenient and reliable data synchronization for all supported
data categories (email, calendar, contacts, tasks) so the API provides methods to receive changes/deltas
and be notified of the changes (through webhooks) in a unified manner. The API''s sync/deltas model
should allow developers to build reliable event based solutions easily.
The Aurinko API is built on HTTP. Our API is RESTful. It has predictable resource URLs.
It returns HTTP response codes to indicate errors. It also accepts and returns JSON in the HTTP body.
## API Authentication
When you sign up for an account, you are given a Client Id and Secret
for every application that you create. You use those to go through OAuth flows that allow you
to start syncing remote account data through Aurinko. An account OAuth flow can be started with
just the Client Id and the Client Secret will be required to obtain an account access token in the
"authorization code" flow ("implicit grant" flow does is secured by the "trusted domains" setting).
Aurinko offers two forms of authentication:
- `Basic ` - used for authentication flows and administrative requests made from the server side.
- `Bearer ` - used for working with an account data.
- `Api Key in Cookie` - for in-browser apps that use Aurinko as their backend API with user sessions.
- `Api Key in Header (X-Aurinko-Session)` - for server side apps that need user sessions
Never share your client secret or access token. Keep them guarded and secure.
## Getting Started Guide
If you have a use case you would like to implement, please consult us for feedback on the best API operations for the task.
Click here to visit our API Guides.'
termsOfService: https://www.aurinko.io/terms-of-service/
title: Aurinko.io Account API
version: 1.0.0
servers:
- url: https://api.aurinko.io
description: Production server
security:
- AccountToken: []
- AppAuth: []
AccountIdHeader: []
- UserSessionHeader: []
AccountIdHeader: []
- UserSessionCookie: []
ClientIdHeader: []
AccountIdHeader: []
- AuthTypeHeader: []
ExchangeIdToken: []
ClientIdHeader: []
AccountIdHeader: []
tags:
- name: Account
description: An account corresponds to an email address, mailbox, and/or calendar. When connecting to the Aurinko API, a specific access token gives you access to a specific account’s data.
paths:
/v1/account:
get:
operationId: getMyAccount
tags:
- Account
summary: Get account status
parameters:
- schema:
type:
- boolean
- 'null'
in: query
name: pingProvider
description: If true, the provider will be pinged to check if the token is still valid. Currently supported only for Google, Office365, Salesforce and NetSuite.
required: false
- in: query
name: includeProviderAuth
required: false
schema:
type:
- boolean
- 'null'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ApiAccountOutDto'
'401':
$ref: '#/components/responses/UnauthorizedError'
x-codeSamples:
- lang: cURL
source: "curl -X GET -H 'Authorization: Bearer <access token>' \\\n https://api.aurinko.io/v1/account"
delete:
operationId: deleteAccount
tags:
- Account
summary: Delete the account
responses:
'200':
description: Success
'401':
$ref: '#/components/responses/UnauthorizedError'
x-codeSamples:
- lang: cURL
source: "curl -X DELETE -H 'Authorization: Bearer <access token>' \\\n https://api.aurinko.io/v1/account"
/v1/account/token:
delete:
operationId: deleteToken
tags:
- Account
summary: Delete the token and revoke all provider authentication data associated with it
responses:
'200':
description: Success
'401':
$ref: '#/components/responses/UnauthorizedError'
x-codeSamples:
- lang: cURL
source: "curl -X DELETE -H 'Authorization: Bearer <access token>' \\\n https://api.aurinko.io/v1/account/token"
components:
schemas:
Scope:
type: string
enum:
- Calendar.Read
- Calendar.ReadWrite
- Mail.Read
- Mail.ReadWrite
- Mail.Send
- Mail.Drafts
- Mail.All
- Contacts.Read
- Contacts.ReadWrite
- Tasks.Read
- Tasks.ReadWrite
description: Space separated list of scopes
ServiceType:
type: string
enum:
- Google
- GoogleBot
- Office365
- EWS
- IMAP
- Salesforce
- Salesflare
- Repfabric
- MsTeamsBot
- Slack
- SlackBot
- SugarCRM
- HighLevel
- Hubspot
- Zoom
- ZoomBot
- Webex
- WebexBot
- Pipedrive
- EclipseERP
- AutoQuotes
- Teamwork
- NetSuite
- MCTrade
- SpecPath
- Zoho
- Clientify
- QuickBooks
- ActiveCampaign
- Creatio
- ConstantContact
- Fishbowl
- iCloud
NativeScope:
type: string
description: Native scope from provider's API.
AccountType:
type: string
enum:
- daemon
- personal
- managed
ApiAccountOutDto:
type: object
properties:
id:
type: integer
format: int64
parentId:
type: integer
format: int64
serviceType:
$ref: '#/components/schemas/ServiceType'
active:
type: boolean
description: The account is always active in the current API version
tokenStatus:
$ref: '#/components/schemas/TokenStatus'
tokenError:
type: string
type:
$ref: '#/components/schemas/AccountType'
daemon:
type: boolean
loginString:
type: string
email:
type: string
mailboxAddress:
type: string
name:
type: string
name2:
type: string
serverUrl:
type: string
serverUrl2:
type: string
clientOrgId:
type: string
authUserId:
type: string
authOrgId:
type: string
timezone:
type: string
tokenIssuedAt:
type: string
format: date-time
authScopes:
type: array
items:
$ref: '#/components/schemas/Scope'
authNativeScopes:
type: array
items:
$ref: '#/components/schemas/NativeScope'
authObtainedAt:
type: string
format: date-time
authExpiresAt:
type: string
format: date-time
userId:
type: string
TokenStatus:
type: string
enum:
- active
- invalid
- dead
description: "* active - means the token is active and ready for use\n* invalid - means that Aurinko failed to access provider API with authentication data.\n Basically it indicates that Aurinko has received a 401 http status from provider and marked this token as non-active.\n* dead - this is a special variant of \"invalid\" status that can occur only with OAuth 2.0 accounts.\n It means that Aurinko failed to refresh OAuth access token and received \"invalid_grant\" error which indicates\n that the access/refresh tokens pair cannot be used anymore and is basically dead.\n The difference between invalid and dead is that with invalid tokens Aurinko will still try to\n access provider API and with dead Aurinko won't even attempt:\n trying to use dead token, Aurinko will just return 401 without making calls to the provider.\n"
responses:
UnauthorizedError:
description: Access token is missing or invalid
securitySchemes:
AppAuth:
type: http
scheme: basic
description: App-level basic authentication using Client ID and Client Secret that can be obtained at Aurinko Dashboard page.
AccountToken:
type: http
scheme: bearer
description: Account-level authentication with account token obtained using `/auth/authorize` endpoint.
UserSessionCookie:
type: apiKey
in: cookie
name: AUR{APPID}
description: Cookie-based user-level authentication
UserSessionHeader:
type: apiKey
in: header
name: X-Aurinko-Session
description: Token-based user-level authentication
ClientIdHeader:
type: apiKey
in: header
name: X-Aurinko-Client-Id
description: Client ID that can be obtained at Aurinko Dashboard page
AccountIdHeader:
type: apiKey
in: header
name: X-Aurinko-Account-Id
description: User account id
AuthTypeHeader:
type: apiKey
in: header
name: X-Aurinko-Auth-Type
description: 'Authentication type. Possible values: default, exchangeIdToken'
ExchangeIdToken:
type: http
scheme: bearer
bearerFormat: 'Exchange Identity Token (only with `X-Aurinko-Auth-Type: exchangeIdToken` header.)'
description: 'Authentication using Exchange Identity Token. To use this method `X-Aurinko-Auth-Type: exchangeIdToken` header should be used.'
x-tagGroups:
- name: OAuth Flow
tags:
- Auth
- Account
- User
- name: Account management
tags:
- Accounts
- Services
- Managed accounts
- name: Email
tags:
- Messages
- EmailSync
- Drafts
- EmailFolders
- EmailTracking
- FollowUpRobot
- name: Calendars
tags:
- Calendars
- Events
- CalSync
- FreeBusySchedule
- name: Scheduling
tags:
- Booking
- GroupBooking
- Availability
- name: Contacts
tags:
- Contacts
- ContSync
- name: Tasks
tags:
- TaskLists
- Tasks
- TaskSync
- name: Webhooks
tags:
- Webhooks
- name: Other
tags:
- Errors