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

Knak Fields API

Create and list custom contact fields (schema metadata).

Knak Fields API is one of 21 APIs that Knak publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

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

Requests are made against a single base URL, https://yourService.com/your-sync-location-api.

3 operations 2 paths 7 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
V1
Base URL
https://enterprise.knak.io/api/published/v1
Resource Areas
1

Paths & Operations 3

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

Fields 3

Create and list custom contact fields (schema metadata).

GET
/fields
List fields
listFields → 200401403429
POST
/fields
Create a field
createField body → 201401403409422429
GET
/fields/{id}/values
List a field's values
listFieldValues 4 params → 200401403404422429

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are PaginationMeta (6 properties), Field (5 properties), ErrorList (2 properties), FieldInput (2 properties). Each schema is shown below with its type and property counts.

PaginationMeta
object
Pagination metadata describing the current result window.
6 properties
Field
object
A custom contact field (schema metadata).
5 properties
HttpError
object
The error shape returned for rate-limit (429) errors.
2 properties
FieldInput
object
The payload used to create a field.
2 properties 2 required
ErrorObject
object
The compact error shape returned for authentication, authorization and conflict errors.
1 property
ErrorList
object
The error shape returned for validation and not-found errors.
2 properties
FieldType
string
The data type of a field.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

knak-fields-api-openapi.yml Raw ↑

Other APIs Knak publishes across the network.

Knak Asset Custom Fieldsets API
Knak AssetFolders API
Knak Assets API
Knak AvailablePlatforms API
Knak Brands API
Knak Contacts API
Knak DAM Assets API
Knak Integrations API
Knak MarketingPlatformSyncs API
Knak MergeTags API
Knak Modules API
Knak OAuth2 API