How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Iterable

Iterable Users API

Manage user profiles, update user fields, bulk update users, get user data by email or userId, and delete users.

Documentation Provider Profile APIs.io OpenAPI GitHub

Iterable Users API is one of 30 APIs that Iterable publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 30 operations across 26 paths, and defines 29 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 3 base URLs: https://api.iterable.com/, https://api.iterable.com/api, https://api.eu.iterable.com/api.

30 operations 26 paths 29 schemas 4 DELETE11 GET15 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.iterable.com
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Iterable Users API declares 2 security schemes for authenticating requests. An API key is passed in the header as Api-Key (api_key). An API key is passed in the header as Api-Key (apiKeyAuth).

  • apiKeyAuth — Iterable API key passed in the Api-Key header. API keys can be created and managed in the Iterable project settings.

Paths & Operations 30

Across 26 paths, the API surfaces 30 operations — 4 DELETE, 11 GET, 15 POST. Each is listed below with its method, path, parameters, and response codes.

users 30
POST
/api/auth/jwts/invalidate
Invalidate all JWTs issued for a user
Invalidate JWT body → 400401
POST
/api/users/bulkUpdate
Bulk update user data
bulkUpdateUser body → 200400401429
POST
/api/users/bulkUpdateSubscriptions
Bulk update user subscriptions
bulkUpdateSubscriptions body → 200400401409
GET
/api/users/byUserId
Get a user by userId (query parameter)
getUserById 1 param → 200400401
DELETE
/api/users/byUserId/{userId}
Delete user by userId
delete 1 param → 200400401
GET
/api/users/byUserId/{userId}
Get a user by userId (path parameter)
getUserById 1 param → 200400401
POST
/api/users/disableDevice
Disable pushes to a mobile device
disableDevice body → 200400401
POST
/api/users/forget
Forget a user in compliance with GDPR
forget body → 200400401
GET
/api/users/forgotten
Get hashed forgotten users in compliance with GDPR
exportProjectForgottenUsers → 200400401
GET
/api/users/forgottenUserIds
Get hashed forgotten userIds in compliance with GDPR
exportProjectForgottenUserIds → 200400401
GET
/api/users/getByEmail
Get a user by email (query parameter)
getUser 1 param → 200400401
GET
/api/users/getFields
Get all user fields
getUserFields → 200400401
GET
/api/users/getSentMessages
Get messages sent to a user
getSentMessages 8 params → 200400401
POST
/api/users/merge
Merge users
mergeUsers body → 200400401403409
POST
/api/users/registerBrowserToken
Register a browser token for web push
registerBrowserToken body → 200400401409
POST
/api/users/registerDeviceToken
Register a device token for push
registerDeviceToken body → 200400401409
POST
/api/users/unforget
Unforget a user in compliance with GDPR
unforget body → 200400401
POST
/api/users/update
Update user data
updateUser body → 200400401409429
POST
/api/users/updateEmail
Update user email
updateEmail body → 200400401409
POST
/api/users/updateSubscriptions
Update user subscriptions
updateSubscriptions body → 200400401409
DELETE
/api/users/{email}
Delete a user by email
delete 1 param → 200400401
GET
/api/users/{email}
Get a user by email (path parameter)
getUser 1 param → 200400401
POST
/users/update
Update a user profile
updateUser body → 200400401
POST
/users/bulkUpdate
Bulk update user profiles
bulkUpdateUsers body → 200400401
GET
/users/{email}
Get a user by email
getUserByEmail 1 param → 200400401404
DELETE
/users/{email}
Delete a user by email
deleteUserByEmail 1 param → 200401404
GET
/users/byUserId/{userId}
Get a user by userId
getUserByUserId 1 param → 200400401404
DELETE
/users/byUserId/{userId}
Delete a user by userId
deleteUserByUserId 1 param → 200401404
GET
/users/getFields
Get user fields
getUserFields → 200401
POST
/users/registerDeviceToken
Register a device token
registerDeviceToken body → 200400401

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are FailedUserUpdates (10 properties), UpdateSubscriptionsRequest (9 properties), UserBulkUpdateListResponse (7 properties), BulkUpdateSubscriptionsResponse (6 properties). Each schema is shown below with its type and property counts.

UserBulkUpdateListResponse
object
7 properties 2 required
RegisterDeviceTokenRequest
object
4 properties 1 required
InvalidateJwtRequest
object
3 properties
DisableDeviceRequest
object
3 properties 1 required
GetForgottenUserIdsResponse
object
1 property 1 required
UpdateEmailRequest
object
3 properties 1 required
ApiUserUpdateRequest
object
6 properties
UpdateSubscriptionsRequest
object
9 properties
MergeUsersRequest
object
5 properties
BulkUpdateUsersRequest
object
2 properties 1 required
GetSentMessagesResponse
object
1 property 1 required
UserRequest
object
2 properties
GetUserFieldsResponse
object
1 property 1 required
BulkUpdateSubscriptionsResponse
object
6 properties 6 required
RegisterBrowserTokenRequest
object
3 properties 1 required
IterableApiResponse
object
3 properties 2 required
UserResponse
object
1 property
GetForgottenUserEmailsResponse
object
1 property 1 required
OptionalApiUser
object
5 properties
ApiResponseUser
object
3 properties 1 required
ArrayMerge
object
2 properties
Device
object
4 properties 3 required
SentMessage
object
4 properties 4 required
FailedUserUpdates
object
10 properties
BulkUpdateSubscriptionsRequest
object
1 property 1 required
UserUpdateRequest
object
Request body for updating a user profile
5 properties
ErrorResponse
object
Error response returned when a request fails validation
3 properties
IterableResponse
object
Standard Iterable API response indicating success or failure
3 properties
UserResponse_2
object
User profile response containing all user data
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

iterable-users-api-openapi.yml Raw ↑

Other APIs Iterable publishes across the network.

Iterable Export API
AE Profile APIs.io
Iterable Web SDK
AE Profile APIs.io
Iterable iOS SDK
AE Profile APIs.io
Iterable Android SDK
AE Profile APIs.io
Iterable React Native SDK
AE Profile APIs.io
Iterable Campaigns API
AE Profile APIs.io
Iterable Catalogs API
AE Profile APIs.io
Iterable Channels API
AE Profile APIs.io
Iterable Commerce API
AE Profile APIs.io
Iterable Email API
AE Profile APIs.io
Iterable Events API
AE Profile APIs.io
Iterable Experiments API
AE Profile APIs.io
#User
← Back to I APIs
API Details
ID
iterable:iterable-users-api
Base URL
https://api.iterable.com
Docs
https://api.iterable.com/api/docs
Provider
Iterable
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=iterable-users-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/iterable-users-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Iterable Users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.