Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Knack Object Records API

CRUD operations on records via object endpoints

Knack Object Records API is one of 3 APIs that Knack publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Object Records. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against a single base URL, https://api.knack.com/v1.

5 operations 2 paths 5 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Base URL
https://api.knack.com/v1
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Knack Object Records API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-Knack-Application-Id (ApplicationId). An API key is passed in the header as X-Knack-REST-API-Key (RestApiKey). By default, every request must be authenticated.

  • ApplicationId — Knack Application ID identifying the target application
  • RestApiKey — REST API key authorizing the request

Paths & Operations 5

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

Object Records 5

CRUD operations on records via object endpoints

GET
/objects/{object_key}/records
List Object Records
listObjectRecords 6 params → 200401
POST
/objects/{object_key}/records
Create Object Record
createObjectRecord 1 param body → 200401
GET
/objects/{object_key}/records/{record_id}
Get Object Record
getObjectRecord 2 params → 200401404
PUT
/objects/{object_key}/records/{record_id}
Update Object Record
updateObjectRecord 2 params body → 200401404
DELETE
/objects/{object_key}/records/{record_id}
Delete Object Record
deleteObjectRecord 2 params → 200401404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are RecordListResponse (4 properties), ErrorResponse (1 property), DeleteResponse (1 property), Record (1 property). Each schema is shown below with its type and property counts.

RecordRequest
object
Payload to create or update a record. Use field keys (fieldX) as property names with appropriate values for each field type.
Record
object
A Knack record. Fields are keyed by field IDs (for example, field1).
1 property
DeleteResponse
object
1 property
RecordListResponse
object
4 properties
ErrorResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

knack-object-records-api-openapi.yml Raw ↑

Other APIs Knack publishes across the network.

Knack REST API
Knack View Records API