Yoxel Email Folders API
List email folders, their attributes, and messages.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/aurinko:aurinko-emailfolders-api"
All apis
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.
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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
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 Email Folders 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: EmailFolders
x-displayName: Email folders
description: List email folders, their attributes, and messages.
paths:
/v1/email/folders:
post:
operationId: createFolder
tags:
- EmailFolders
summary: Create a new email folder
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EmailFolderCreate'
responses:
'201':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/EmailFolderInfo'
x-codeSamples:
- lang: cURL
source: "curl -H 'Authorization: Bearer <access token>' \\\n -X POST https://api.aurinko.io/v1/email/folders \\\n -d '{\n \"name\": \"Folder name\"\n }'"
get:
operationId: folders
tags:
- EmailFolders
summary: List email folders
parameters:
- schema:
type:
- string
- 'null'
in: query
name: pageToken
required: false
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/EmailFolderInfoPage'
x-codeSamples:
- lang: cURL
source: "curl -X GET -H 'Authorization: Bearer <access token>' \\\n -G https://api.aurinko.io/v1/email/folders"
/v1/email/folders/wellKnown:
patch:
operationId: updateWellKnownFolders
tags:
- EmailFolders
summary: Update wellKnown email folders
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/WellKnownFoldersIn'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/WellKnownFoldersOut'
x-codeSamples:
- lang: cURL
source: "curl -X PATCH -H 'Authorization: Bearer <access token>' \\\n -G https://api.aurinko.io/v1/email/folders/wellKnown \\\n -d '{\n \"archive\": \"folderXid\"\n }'"
get:
operationId: wellKnownFolders
tags:
- EmailFolders
summary: List wellKnown email folders
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/WellKnownFoldersOut'
x-codeSamples:
- lang: cURL
source: "curl -X GET -H 'Authorization: Bearer <access token>' \\\n -G https://api.aurinko.io/v1/email/folders/wellKnown"
/v1/email/folders/{folderId}:
get:
operationId: folder
tags:
- EmailFolders
summary: Get an email folder
parameters:
- schema:
type: string
in: path
name: folderId
description: email folder identifier
required: true
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/EmailFolderInfo'
x-codeSamples:
- lang: cURL
source: "curl -X GET -H 'Authorization: Bearer <access token>' \\\n https://api.aurinko.io/v1/email/folders/{id}"
/v1/email/folders/{folderId}/messages:
get:
operationId: folderEmails
tags:
- EmailFolders
summary: List email messages in a specified folder
parameters:
- in: path
name: folderId
required: true
schema:
type: string
- schema:
type:
- string
- 'null'
in: query
name: pageToken
required: false
- schema:
type:
- string
- 'null'
in: query
name: q
description: 'Only return messages matching the specified query. For example, "from:someuser@example.com after:01/01/2020"
'
required: false
- schema:
type:
- bodytype
- 'null'
$ref: '#/components/schemas/BodyType'
in: query
name: bodyType
required: false
- schema:
type:
- array
- 'null'
items:
type: nativeproperty
$ref: '#/components/schemas/NativeProperty'
in: query
name: nativeProperties
required: false
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/EmailMessagesPageNext'
x-codeSamples:
- lang: cURL
source: "curl -X GET -H 'Authorization: Bearer <access token>' \\\n -G https://api.aurinko.io/v1/email/messages\n -d q='text to:{address_or_name}'"
components:
schemas:
EmailAttachment:
type: object
properties:
id:
type: string
readOnly: true
name:
type: string
readOnly: true
mimeType:
type: string
readOnly: true
size:
type: integer
readOnly: true
inline:
type: boolean
readOnly: true
contentId:
type: string
readOnly: true
content:
type: string
readOnly: true
contentLocation:
type: string
readOnly: true
EmailHeader:
type: object
properties:
name:
type: string
value:
type: string
NativeProperty:
type: string
EmailAddress:
type: object
properties:
name:
type: string
address:
type: string
format: email
raw:
type: string
readOnly: true
BodyType:
type: string
enum:
- html
- text
WellKnownFoldersOut:
type: object
properties:
archive:
type: string
description: an xid of folder marked as an Archive
WellKnownFoldersIn:
type: object
properties:
archive:
type: string
description: an xid of folder - to mark it as Archive, set to null to clear Archive folder
EmailFolderInfo:
type: object
properties:
id:
type: string
readOnly: true
name:
type: string
readOnly: true
fullName:
type: string
readOnly: true
isFolder:
type: boolean
readOnly: true
isLabel:
type: boolean
readOnly: true
parentId:
type: string
readOnly: true
EmailFolderCreate:
type: object
properties:
name:
type: string
parentId:
type: string
description: parent folder identifier
EmailFolderInfoPage:
type: object
properties:
length:
type: integer
records:
type: array
items:
$ref: '#/components/schemas/EmailFolderInfo'
Sensitivity:
type: string
enum:
- normal
- private
- personal
- confidential
EmailMessage:
type: object
properties:
id:
type: string
readOnly: true
threadId:
type: string
readOnly: true
createdTime:
type: string
format: date-time
readOnly: true
lastModifiedTime:
type: string
format: date-time
readOnly: true
sentAt:
type: string
format: date-time
readOnly: true
receivedAt:
type: string
format: date-time
readOnly: true
internetMessageId:
type: string
readOnly: true
subject:
type: string
readOnly: true
sysLabels:
type: array
readOnly: true
items:
type: string
enum:
- junk
- trash
- sent
- inbox
- unread
- flagged
- important
- draft
keywords:
type: array
items:
type: string
sysClassifications:
type: array
readOnly: true
items:
type: string
enum:
- personal
- social
- promotions
- updates
- forums
sensitivity:
$ref: '#/components/schemas/Sensitivity'
meetingMessageMethod:
type: string
enum:
- request
- reply
- cancel
- counter
- other
from:
$ref: '#/components/schemas/EmailAddress'
to:
type: array
items:
$ref: '#/components/schemas/EmailAddress'
cc:
type: array
items:
$ref: '#/components/schemas/EmailAddress'
bcc:
type: array
items:
$ref: '#/components/schemas/EmailAddress'
replyTo:
type: array
items:
$ref: '#/components/schemas/EmailAddress'
hasAttachments:
type: boolean
readOnly: true
body:
type: string
readOnly: true
bodySnippet:
type: string
readOnly: true
attachments:
type: array
items:
$ref: '#/components/schemas/EmailAttachment'
inReplyTo:
type: string
readOnly: true
references:
type: string
readOnly: true
threadIndex:
type: string
readOnly: true
internetHeaders:
type: array
items:
$ref: '#/components/schemas/EmailHeader'
nativeProperties:
type: object
additionalProperties:
type: string
folderId:
type: string
readOnly: true
webLink:
type: string
readOnly: true
omitted:
type: array
readOnly: true
items:
type: string
enum:
- threadId
- body
- attachments
- recipients
- internetHeaders
EmailMessagesPageNext:
type: object
properties:
nextPageToken:
type: string
length:
type: integer
records:
type: array
items:
$ref: '#/components/schemas/EmailMessage'
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