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
Knock

Knock Users API

The Users API from Knock — 28 operation(s) for users.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

This API exposes 2 JSON Schema definitions.

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

This API exposes 18 operations across 14 paths, and defines 34 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api.knock.app.

18 operations 14 paths 34 schemas 2 DELETE4 GET4 POST8 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Server
https://api.knock.app
Authentication
HTTP Bearer
Contact
Knock
License
Proprietary
Resource Areas
1

Authentication & Security 1

Knock Users API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • BearerAuth — Knock API key as a Bearer token. Use a public key (pk...) for client-side requests or a secret key (sk...) for server-side.

Paths & Operations 18

Across 14 paths, the API surfaces 18 operations — 2 DELETE, 4 GET, 4 POST, 8 PUT. Each is listed below with its method, path, parameters, and response codes.

Users 18
DELETE
/v1/users/{user_id}
Delete user
deleteUser 1 param → 204
GET
/v1/users/{user_id}
Get user
getUser 1 param → 200
PUT
/v1/users/{user_id}
Identify user
identifyUser 1 param body → 200
PUT
/v1/users/{user_id}/preferences/{id}/categories/{key}deprecated
Update category in user preference set
updateUserPreferenceCategory → 200
POST
/v1/users/{user_id}/merge
Merge users
mergeUser 1 param body → 200
POST
/v1/users/bulk/preferences
Bulk set preferences
bulkSetUserPreferences body → 200
POST
/v1/users/bulk/identify
Bulk identify users
bulkIdentifyUsers body → 200
PUT
/v1/users/{user_id}/preferences/{id}/workflowsdeprecated
Update workflows in preference set
updateUserPreferenceWorkflows → 200
PUT
/v1/users/{user_id}/preferences/{id}/categoriesdeprecated
Update categories in user preference set
updateUserPreferenceCategories → 200
POST
/v1/users/bulk/delete
Bulk delete users
bulkDeleteUsers body → 200
PUT
/v1/users/{user_id}/preferences/{id}/channel_types/{type}deprecated
Update channel type in preference set
updateUserPreferenceChannelType → 200
GET
/v1/users/{user_id}/preferences
List user preference sets
listUserPreferenceSets 1 param → 200
GET
/v1/users
List users
listUsers 4 params → 200
PUT
/v1/users/{user_id}/preferences/{id}/workflows/{key}deprecated
Update workflow in user preference set
updateUserPreferenceWorkflow → 200
DELETE
/v1/users/{user_id}/preferences/{id}
Delete user preference set
deleteUserPreferenceSet 2 params → 204
GET
/v1/users/{user_id}/preferences/{id}
Get user preference set
getUserPreferenceSet 3 params → 200
PUT
/v1/users/{user_id}/preferences/{id}
Update user preference set
updateUserPreferenceSet 2 params body → 200
PUT
/v1/users/{user_id}/preferences/{id}/channel_typesdeprecated
Update channel types in preference set
updateUserPreferenceChannelTypes → 200

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are BulkOperation (15 properties), InlineIdentifyUserRequest (10 properties), User (9 properties), IdentifyUserRequest (9 properties). Each schema is shown below with its type and property counts.

MsTeamsIncomingWebhookConnection
object
Microsoft Teams incoming webhook connection.
1 property 1 required
MsTeamsChannelData
object
Microsoft Teams channel data.
2 properties 1 required
ListUsersResponse
object
A paginated list of users.
2 properties
OneSignalChannelDataPlayerIdsOnly
object
OneSignal channel data.
1 property 1 required
AWSSNSPushChannelDataDevicesOnly
object
AWS SNS push channel data.
1 property 1 required
DiscordChannelConnection
object
Discord channel connection.
1 property 1 required
PreferenceSetChannels
object
Channel preferences.
PushChannelDataDevicesOnly
object
Push channel data.
1 property 1 required
IdentifyUserRequest
object
A set of parameters to identify a user with. Does not include the user ID, as that's specified elsewhere in the request. You can supply any additional properti…
9 properties
BulkDeleteUsersRequest
object
A request to delete users in bulk.
1 property 1 required
PreferenceSetWorkflowCategorySetting
object
Workflow or category preferences within a preference set
PreferenceSetChannelSetting
object
A set of settings for a specific channel. Currently, this can only be a list of conditions to apply.
1 property 1 required
AWSSNSPushChannelDataTargetARNsOnly
object
AWS SNS push channel data.
1 property 1 required
MergeUserRequest
object
A set of parameters to merge one user into another.
1 property 1 required
InlinePreferenceSetRequest
object
Inline set preferences for a recipient, where the key is the preference set id. Preferences that are set inline will be merged into any existing preferences ra…
InlineChannelDataRequest
object
A request to set channel data for a type of channel inline.
BulkIdentifyUsersRequest
object
A request to identify a list of users.
1 property 1 required
PreferenceSetChannelTypeSetting
object
A set of settings for a channel type. Currently, this can only be a list of conditions to apply.
1 property 1 required
DiscordChannelData
object
Discord channel data.
1 property 1 required
InlineIdentifyUserRequest
object
A set of parameters to inline-identify a user with. Inline identifying the user will ensure that the user is available before the request is executed in Knock.…
10 properties 1 required
PushChannelDataTokensOnly
object
Push channel data.
1 property 1 required
PreferenceSet
object
A preference set represents a specific set of notification preferences for a recipient. A recipient can have multiple preference sets.
6 properties 1 required
SlackChannelData
object
Slack channel data.
2 properties 1 required
PreferenceSetChannelTypes
object
Channel type preferences.
6 properties
User
object
A [User](/concepts/users) represents an individual in your system who can receive notifications through Knock. Users are the most common recipients of notifica…
9 properties 3 required
SlackIncomingWebhookConnection
object
A Slack connection incoming webhook.
1 property 1 required
SlackTokenConnection
object
A Slack connection token.
3 properties
Condition
object
A condition to be evaluated.
3 properties 3 required
PageInfo
object
Pagination information for a list of resources.
4 properties 2 required
BulkOperation
object
A bulk operation entity.
15 properties 9 required
MsTeamsTokenConnection
object
Microsoft Teams token connection.
4 properties
BulkSetUserPreferencesRequest
object
A request to set preferences for a set of users in bulk.
2 properties 2 required
DiscordIncomingWebhookConnection
object
Discord incoming webhook connection.
1 property 1 required
PreferenceSetRequest
object
A request to set a preference set for a recipient.
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

knock-app-users-api-openapi.yml Raw ↑

Other APIs Knock publishes across the network.

Knock Outbound Webhooks
AE Profile APIs.io
Knock Accounts API
AE Profile APIs.io
Knock API keys API
AE Profile APIs.io
Knock Audiences API
AE Profile APIs.io
Knock Branches API
AE Profile APIs.io
Knock Broadcasts API
AE Profile APIs.io
Knock Bulk operations API
AE Profile APIs.io
Knock Channel data API
AE Profile APIs.io
Knock Channel Groups API
AE Profile APIs.io
Knock Channels API
AE Profile APIs.io
Knock Commits API
AE Profile APIs.io
Knock Email layouts API
AE Profile APIs.io
#User
← Back to K APIs
API Details
ID
knock-app:knock-app-users-api
Server
https://api.knock.app
Docs
https://docs.knock.app/api-reference/workflows
Provider
Knock
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=knock-app-users-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/knock-app-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 Knock 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.