Knock Bulk operations API
A bulk operation is a set of changes applied across zero or more records triggered via a call to the Knock API and performed asynchronously.
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/knock-bulk-operations-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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Knock Bulk operations API
version: '1.0'
description: A bulk operation is a set of changes applied across zero or more records triggered via a call to the Knock API and performed asynchronously.
servers:
- url: https://api.knock.app
variables: {}
security:
- BearerAuth: []
tags:
- description: A bulk operation is a set of changes applied across zero or more records triggered via a call to the Knock API and performed asynchronously.
name: Bulk operations
paths:
/v1/bulk_operations/{id}:
get:
callbacks: {}
description: Retrieves a bulk operation (if it exists) and displays the current state of it.
operationId: getBulkOperation
parameters:
- description: The ID of the bulk operation to retrieve.
in: path
name: id
required: true
schema:
format: uuid
type: string
x-struct: null
x-validate: null
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BulkOperation'
description: OK
summary: Get bulk operation
tags:
- Bulk operations
x-ratelimit-tier: 4
components:
schemas:
BulkOperation:
description: A bulk operation entity.
example:
__typename: BulkOperation
completed_at: null
error_count: 0
error_items: []
estimated_total_rows: 1000
failed_at: null
id: 123e4567-e89b-12d3-a456-426614174000
inserted_at: '2024-05-22T12:00:00Z'
name: Bulk operation name
processed_rows: 0
progress_path: https://api.switchboard.com/v1/bulk_operations/123e4567-e89b-12d3-a456-426614174000
started_at: null
status: processing
success_count: 0
updated_at: '2024-05-22T12:00:00Z'
properties:
__typename:
description: The typename of the schema.
example: BulkOperation
type: string
x-struct: null
x-validate: null
completed_at:
description: Timestamp when the bulk operation was completed.
format: date-time
type:
- string
- 'null'
x-struct: null
x-validate: null
error_count:
description: The number of failed operations.
example: 0
type: integer
x-struct: null
x-validate: null
error_items:
description: A list of items that failed to be processed.
items:
properties:
collection:
description: The collection this object belongs to.
type:
- string
- 'null'
x-struct: null
x-validate: null
id:
description: Unique identifier for the object.
type: string
x-struct: null
x-validate: null
required:
- id
type: object
x-struct: null
x-validate: null
type: array
x-struct: null
x-validate: null
estimated_total_rows:
description: The estimated total number of rows to process.
example: 1000
type: integer
x-struct: null
x-validate: null
failed_at:
description: Timestamp when the bulk operation failed.
format: date-time
type:
- string
- 'null'
x-struct: null
x-validate: null
id:
description: Unique identifier for the bulk operation.
format: uuid
type: string
x-struct: null
x-validate: null
inserted_at:
description: Timestamp when the resource was created.
format: date-time
type: string
x-struct: null
x-validate: null
name:
description: The name of the bulk operation.
example: Bulk operation name
type: string
x-struct: null
x-validate: null
processed_rows:
description: The number of rows processed so far.
example: 0
type: integer
x-struct: null
x-validate: null
progress_path:
description: The URI to the bulk operation's progress.
format: uri
type: string
x-struct: null
x-validate: null
started_at:
description: Timestamp when the bulk operation was started.
format: date-time
type:
- string
- 'null'
x-struct: null
x-validate: null
status:
description: The status of the bulk operation.
enum:
- queued
- processing
- completed
- failed
example: queued
type: string
x-struct: null
x-validate: null
success_count:
description: The number of successful operations.
example: 0
type: integer
x-struct: null
x-validate: null
updated_at:
description: The timestamp when the resource was last updated.
format: date-time
type: string
x-struct: null
x-validate: null
required:
- __typename
- id
- name
- status
- estimated_total_rows
- processed_rows
- success_count
- updated_at
- inserted_at
title: BulkOperation
type: object
x-struct: Elixir.SwitchboardWeb.V1.Specs.BulkOperation
x-validate: null
securitySchemes:
BearerAuth:
bearerFormat: JWT
scheme: bearer
type: http