The Account Services API from Return Path — 13 operation(s) for account services.
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/return-path-account-services-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
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:
title: Everest Account Services API
version: '2.0'
summary: Email deliverability, inbox placement, sender reputation and DMARC intelligence — the Validity Everest API, the surviving surface of the Return Path platform.
description: 'API Limit: 500 requests per minute. Limit increases are available on a per-customer basis by contacting our support team.
Welcome to the Everest API (V2) by Validity. We''ll be rolling out additional product support in the coming months. It''s important to note that V2 of our API is purely optional. We hope you find it simpler to use, more intuitive, and better documented, but we plan to continue supporting API V1.
All API requests utilize REST methods resulting in JSON, XML, CSV, or Serialized output. To request new API functionality please feel free to contact us.
Every API request requires the use of the X-API-KEY header, which is located in your account settings.
Throughout the documentation you''ll see the use of variables like YOUR_API_KEY that can be swapped out using your real API key. If you use Postman, this collection is available for download along with a shared variable template to define your host and apikey variables.
All datetime fields are UTC.
Standard API Responses
200 Success
401 Unauthorized (no valid API key provided)
403 Forbidden (indicates lack access to the action you''re performning)
404 Not Found (indicates invalid parameters or missing API endpoint)
429 Too Many Requests (API limits have been reached, retry after some time)
500 Internal Server Error (indicates something went wrong on our end)
Each 400-level error code will contain an status object containing a description of the problem.'
contact:
name: Validity Support
url: https://knowledge.validity.com/
x-derived-from: collections/return-path-everest-api.postman_collection.json
x-source-url: https://developer.everest.validity.com/
x-provenance: DERIVED by API Evangelist from the Postman collection Validity publishes at developer.everest.validity.com. Validity does not publish an OpenAPI document; every path, method, parameter, header, request body and response example here is read verbatim from that collection.
servers:
- url: https://api.everest.validity.com/api
description: 'Everest API. The major version is the first path segment: 2.0 is current, 1.0 is the legacy API Validity says it will continue to support.'
security:
- apiKeyAuth: []
tags:
- name: Account Services
paths:
/2.0/accounts:
get:
operationId: accountsAccounts
summary: Accounts
tags:
- Account Services
description: 'loginslug specifies an account''s SSO endpoint name
owner_email specifies the account owner''s email address
owner_firstname specifies the account owner''s first name
owner_lastnamespecifies the account owner''s last name'
x-api-version: '2.0'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
meta:
type: object
properties:
total:
type: integer
results:
type: array
items:
type: object
properties:
id:
type: integer
name:
type: string
owner_email:
type: string
owner_firstname:
type: string
owner_lastname:
type: string
package:
type: string
expiration:
type: string
volumetier:
type: integer
created:
type: string
updated:
type: string
descendent_of:
type: integer
loginslug:
type: string
preferences:
type: object
properties:
enforce_passwords:
type: integer
enforce_mfa:
type: integer
sso_enabled:
type: integer
timezone:
type: string
global_stats:
type: integer
subscription:
type: object
properties:
addons:
type: object
properties:
validation:
type: integer
optimizedseeds:
type: integer
design:
type: integer
vto:
type: integer
competitive:
type: integer
certification:
type: integer
products:
type: object
properties:
certification:
type: object
properties:
quantity:
type: string
design:
type: object
properties:
quantity:
type: integer
engagement:
type: object
properties:
quantity:
type: integer
inbox:
type: object
properties:
quantity:
type: integer
reputation:
type: object
properties:
quantity:
type: integer
validation:
type: object
properties:
quantity:
type: integer
examples:
Accounts:
value:
meta:
total: 2
results:
- id: 1
name: Everest by Validity
owner_email: sales@validity.com
owner_firstname: Everest
owner_lastname: API
package: Enterprise
expiration: '2026-12-31'
volumetier: 8
created: '2012-05-23T14:56:36+00:00'
updated: '2020-12-16T17:44:30+00:00'
descendent_of: 0
loginslug: everest-by-validity
preferences:
enforce_passwords: 0
enforce_mfa: 0
sso_enabled: 0
timezone: America/New_York
global_stats: 1
subscription:
addons:
validation: 0
optimizedseeds: 0
design: 0
vto: 1
competitive: 0
certification: 1
products:
certification:
quantity: N/A
design:
quantity: 100
engagement:
quantity: 1000000
inbox:
quantity: 10000
reputation:
quantity: 10000
validation:
quantity: 1000000
- id: 2
name: Everest Child Account
owner_email: sales@validity.com
owner_firstname: Everest
owner_lastname: API
package: ''
expiration: ''
volumetier: 0
created: '2012-05-23T14:56:36+00:00'
updated: '2020-12-16T17:44:30+00:00'
descendent_of: 1
loginslug: everest-child-account
preferences:
enforce_passwords: 0
enforce_mfa: 0
sso_enabled: 0
timezone: ''
subscription:
addons:
validation: 0
optimizedseeds: 0
design: 0
vto: 0
competitive: 0
certification: 0
products:
certification:
quantity: N/A
inbox:
quantity: 100
reputation:
quantity: 100000000
validation:
quantity: 100000000
'401':
description: Unauthorized — no valid API key provided
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden — the key lacks access to this action
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found — invalid parameters or missing API endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
description: Too Many Requests — API rate limit reached, retry later
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
post:
operationId: accountsCreateAccount
summary: Create Account
tags:
- Account Services
x-api-version: '2.0'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
package:
type: string
external_id:
type: string
start:
type: string
expiration:
type: string
includeglobalstats:
type: integer
inboxseedlistgroup:
type: integer
inboxreset:
type: string
subscription:
type: object
properties:
addons:
type: object
properties:
competitive:
type: integer
optimizedseeds:
type: integer
design:
type: integer
validation:
type: integer
vto:
type: integer
products:
type: object
properties:
analytics:
type: integer
blacklist:
type: integer
certification:
type: integer
design:
type: integer
dmarc:
type: integer
engagement:
type: integer
inbox:
type: integer
reputation:
type: integer
validation:
type: integer
plan:
type: object
properties:
slug:
type: string
permissions:
type: object
properties:
reputation:
type: string
design:
type: string
example:
name: Account Name
package: Professional
external_id: external-id
start: '2023-01-01'
expiration: '2025-12-31'
includeglobalstats: 0
inboxseedlistgroup: 1
inboxreset: annual
subscription:
addons:
competitive: 1
optimizedseeds: 1
design: 1
validation: 1
vto: 1
products:
analytics: 100
blacklist: 100
certification: 100
design: 100
dmarc: 100
engagement: 100
inbox: 100
reputation: 100
validation: 100
plan:
slug: plan-slug
permissions:
reputation: inactive
design: active
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
meta:
type: object
results:
type: object
properties:
status:
type: string
id:
type: integer
examples:
Create Account:
value:
meta: {}
results:
status: success
id: 1018853
'401':
description: Unauthorized — no valid API key provided
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden — the key lacks access to this action
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found — invalid parameters or missing API endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
description: Too Many Requests — API rate limit reached, retry later
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/2.0/accounts/{accountId}:
get:
operationId: accountsAccountUsage
summary: Account & Usage
tags:
- Account Services
x-api-version: '2.0'
parameters:
- name: accountId
in: path
required: true
schema:
type: string
example: '{{account_id}}'
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
meta:
type: object
properties:
usage_vto:
type: string
volume_tiers:
type: array
items:
type: string
results:
type: object
properties:
id:
type: integer
name:
type: string
owner_email:
type: string
owner_firstname:
type: string
owner_lastname:
type: string
package:
type: string
expiration:
type: string
volumetier:
type: integer
created:
type: string
updated:
type: string
descendent_of:
type: integer
external_id:
type: string
loginslug:
type: string
preferences:
type: object
properties:
enforce_passwords:
type: integer
enforce_mfa:
type: integer
sso_enabled:
type: integer
timezone:
type: string
global_stats:
type: integer
subscription:
type: object
properties:
addons:
type: object
properties:
validation:
type: integer
optimizedseeds:
type: integer
design:
type: integer
vto:
type: integer
competitive:
type: integer
certification:
type: integer
products:
type: object
properties:
certification:
type: object
properties:
quantity:
type: string
design:
type: object
properties:
quantity:
type: integer
usage:
type: integer
engagement:
type: object
properties:
quantity:
type: integer
usage:
type: integer
inbox:
type: object
properties:
quantity:
type: integer
usage:
type: integer
reputation:
type: object
properties:
quantity:
type: integer
usage:
type: integer
validation:
type: object
properties:
quantity:
type: integer
usage:
type: integer
examples:
Get Account:
value:
meta:
usage_vto: /api/2.0/vto/usage
volume_tiers:
- 1 (< 1M)
- 2 (< 3M)
- 3 (3-12M)
- 4 (12-36M)
- 5 (36-120M)
- 6 (120-240M)
- 7 (240M-600M)
- 8 (600M+)
results:
id: 30
name: Everest by Validity
owner_email: sales@validity.com
owner_firstname: Everest
owner_lastname: API
package: Enterprise
expiration: '2026-12-31'
volumetier: 8
created: '2012-05-23T14:56:36+00:00'
updated: '2020-12-16T17:44:30+00:00'
descendent_of: 0
external_id: abc123
loginslug: everest-by-validity
preferences:
enforce_passwords: 0
enforce_mfa: 0
sso_enabled: 0
timezone: America/New_York
global_stats: 1
subscription:
addons:
validation: 0
optimizedseeds: 0
design: 0
vto: 1
competitive: 0
certification: 1
products:
certification:
quantity: N/A
design:
quantity: 100
usage: 19
engagement:
quantity: 1000000
usage: 37529
inbox:
quantity: 10000
usage: 3769
reputation:
quantity: 10000
usage: 37820
validation:
quantity: 1000000
usage: 1019411
Get Account using External Id:
value:
meta:
usage_vto: /api/2.0/vto/usage
volume_tiers:
- 1 (< 1M)
- 2 (< 3M)
- 3 (3-12M)
- 4 (12-36M)
- 5 (36-120M)
- 6 (120-240M)
- 7 (240M-600M)
- 8 (600M+)
results:
id: 30
name: Everest by Validity
owner_email: sales@validity.com
owner_firstname: Everest
owner_lastname: API
package: Enterprise
expiration: '2026-12-31'
volumetier: 8
created: '2012-05-23T14:56:36+00:00'
updated: '2020-12-16T17:44:30+00:00'
descendent_of: 0
external_id: abc123
loginslug: everest-by-validity
preferences:
enforce_passwords: 0
enforce_mfa: 0
sso_enabled: 0
timezone: America/New_York
global_stats: 1
subscription:
addons:
validation: 0
optimizedseeds: 0
design: 0
vto: 1
competitive: 0
certification: 1
products:
certification:
quantity: N/A
design:
quantity: 100
usage: 19
engagement:
quantity: 1000000
usage: 37529
inbox:
quantity: 10000
usage: '3769'
reputation:
quantity: 10000
usage: '37820'
validation:
quantity: 1000000
usage: 1019411
vto:
quantity: N/A
'401':
description: Unauthorized — no valid API key provided
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden — the key lacks access to this action
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found — invalid parameters or missing API endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
description: Too Many Requests — API rate limit reached, retry later
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/2.0/accounts/{userId}:
put:
operationId: accountsUpdateAccount
summary: Update Account
tags:
- Account Services
x-api-version: '2.0'
parameters:
- name: userId
in: path
required: true
schema:
type: string
example: '{{user_id}}'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
package:
type: string
external_id:
type: string
includeglobalstats:
type: integer
inboxseedlistgroup:
type: integer
inboxreset:
type: string
subscription:
type: object
properties:
products:
type: object
properties:
analytics:
type: integer
blacklist:
type: integer
certification:
type: integer
design:
type: integer
dmarc:
type: integer
engagement:
type: integer
inbox:
type: integer
reputation:
type: integer
validation:
type: integer
plan:
type: object
properties:
slug:
type: string
permissions:
type: object
properties:
reputation:
type: string
design:
type: string
example:
name: Account Name
package: Professional
external_id: external-id
includeglobalstats: 0
inboxseedlistgroup: 1
inboxreset: annual
subscription:
products:
analytics: 100
blacklist: 100
certification: 100
design: 100
dmarc: 100
engagement: 100
inbox: 100
reputation: 100
validation: 100
plan:
slug: 5EH934FIOU
permissions:
reputation: inactive
design: inactive
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
meta:
type: object
results:
type: object
properties:
status:
type: string
examples:
Update Account:
value:
meta: {}
results:
status: success
'401':
description: Unauthorized — no valid API key provided
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden — the key lacks access to this action
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Not Found — invalid parameters or missing API endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
description: Too Many Requests — API rate limit reached, retry later
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
delete:
operationId: accountsDeleteAccount
summary: Delete Account
tags:
- Account Services
x-api-version: '2.0'
parameters:
- name: userId
in: path
required: true
schema:
type: string
example: '{{user_id}}'
responses:
'404':
description: Not Found
content:
application/json:
schema:
type: object
properties:
status:
type: string
examples:
Error Account does not exist:
value:
status: Account does not exist
Error Root account deletion:
value:
status: This API does not support deleting your root account. Please contact support for assistance.
'20
# --- truncated at 32 KB (115 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/return-path/refs/heads/main/openapi/return-path-account-services-api-openapi.yml