Nylas

Nylas Lists API

The Lists endpoints let you manage typed collections of values (email addresses, domains, or top-level domains) that can be referenced by Rules using the `in_list` condition operator. Lists provide a way to maintain dynamic allow lists and block lists that are evaluated during inbound rule processing and outbound send evaluation without needing to update individual rules. Each list has a `type` that determines what kind of values it accepts and which rule condition fields it can be matched against: - **`domain`** — Domain names (for example, `example.com`). Matched against the `from.domain` or `recipient.domain` rule condition. - **`tld`** — Top-level domains (for example, `com`, `xyz`). Matched against the `from.tld` or `recipient.tld` rule condition. - **`address`** — Full email addresses (for example, `user@example.com`). Matched against the `from.address` or `recipient.address` rule condition. List `type` is set at creation time and cannot be changed. Items within a list are managed via the `/v3/lists/{list_id}/items` sub-resource endpoints. Values are automatically normalized (lowercased and trimmed) and validated against the list's `type`. Duplicate additions are silently ignored. You can submit up to 1000 items per add or remove request, and each item value can be at most 500 characters.

GitHub OpenAPI

Operations 8

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /v3/lists Create a list of domains, TLDs or addresses · Create a list #
Ask an LLM
“How do I create a blocklist of email domains for my agent account rules?”
“Can I change a list's type after I create it?”
Tell an agent
Create a list named {name} of type {type}.
Make a new {type} list called {name} described as {description}.
GET /v3/lists List all lists in the application · List lists #
Ask an LLM
“What domain, TLD and email address lists have I created for my rules?”
“Can I page through every list my application has?”
Tell an agent
Show all lists in my application.
List my application's lists, {limit} at a time.
GET /v3/lists/{list_id} Get one list's details · Get a list #
Ask an LLM
“What's the type and item count of a specific list?”
“Can I look up one list by its ID?”
Tell an agent
Show list {list}.
Get the details of list {list}.
PUT /v3/lists/{list_id} Rename or redescribe a list · Update a list #
Ask an LLM
“Can I rename an existing list without changing its type?”
“Which fields of a list can be edited after creation?”
Tell an agent
Rename list {list} to {name}.
Change the description of list {list} to {description}.
DELETE /v3/lists/{list_id} Delete a list and all its items · Delete a list #
Ask an LLM
“What happens to rules that reference a list after I delete it?”
“Is deleting a whole list reversible?”
Tell an agent destructive · confirm first
Delete list {list} and everything in it.
Remove the entire list {list} permanently.
POST /v3/lists/{list_id}/items Add values to a list · Add items to a list #
Ask an LLM
“How do I add more domains to an existing list?”
“Are values I add to a list normalized or de-duplicated?”
Tell an agent
Add {items} to list {list}.
Append these entries {items} to list {list}.
GET /v3/lists/{list_id}/items List the values in a list · List items in a list #
Ask an LLM
“Which domains or addresses are currently in a given list?”
“How can I page through the entries of one list?”
Tell an agent
Show the items in list {list}.
List up to {limit} entries from list {list}.
DELETE /v3/lists/{list_id}/items Remove specific values from a list · Remove items from a list #
Ask an LLM
“Can I take a few addresses out of a list without deleting the list?”
“What's the maximum number of items I can remove from a list in one request?”
Tell an agent destructive · confirm first
Remove {items} from list {list}.
Take these entries {items} out of list {list} but keep the list.

Documentation

📖
APIReference
https://developer.nylas.com/docs/reference/notifications/
📖
Documentation
https://developer.nylas.com/docs/v3/notifications/
📖
Documentation
https://developer.nylas.com/docs/
📖
APIReference
https://developer.nylas.com/docs/reference/api/
📖
GettingStarted
https://developer.nylas.com/docs/v3/getting-started/
📖
Authentication
https://developer.nylas.com/docs/v3/auth/
📖
RateLimits
https://developer.nylas.com/docs/dev-guide/platform/rate-limits/
📖
APIReference
https://developer.nylas.com/docs/reference/api/application-level-templates/

Specifications

⚙
OpenAPI
https://artifacts.apis.io/nylas/openapi/nylas-lists-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/nylas/json-schema/nylas-list-object-schema.json
📊
JSONSchema
https://artifacts.apis.io/nylas/json-schema/nylas-list-item-object-schema.json

Other Resources

🔗
ErrorCodes
https://developer.nylas.com/docs/api/errors/
🔗
Pricing
https://www.nylas.com/pricing/
🔗
Signup
https://dashboard-v3.nylas.com/register
🔗
StatusPage
https://status.nylas.com/
🔗
SDKs
https://github.com/nylas/nylas-nodejs
🔗
SDKs
https://github.com/nylas/nylas-python
🔗
SDKs
https://github.com/nylas/nylas-ruby
🔗
SDKs
https://github.com/nylas/nylas-java

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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/nylas:nylas-lists-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

nylas-lists-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Nylas Lists API
  version: v3
  summary: The complete Nylas v3 API — Email, Calendar, Contacts, Notetaker, Scheduling, Administration, and Migration.
  description: The Nylas API is designed using the REST ideology to provide simple and predictable URIs to access and modify objects. Requests support standard HTTP methods like `GET`, `PUT`, `POST`, and `DELETE`, and standard status codes. Response bodies are always UTF-8 encoded JSON objects, unless explicitly documented otherwise. You can use the Nylas Postman collection to quickly start using the Nylas APIs. For more information, check out the Nylas Postman collection documentation.
  contact:
    url: https://www.nylas.com/
servers:
- url: https://api.us.nylas.com
  description: U.S.
- url: https://api.eu.nylas.com
  description: E.U.
security:
- ACCESS_TOKEN: []
- NYLAS_API_KEY: []
tags:


# --- truncated at 32 KB (32 KB total) ---
# Full source: https://artifacts.apis.io/nylas/openapi/nylas-lists-api-openapi.yml