Knak Contacts API is one of 21 APIs that Knak publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Contacts. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
8 operations
across 4 paths,
and defines 11 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.
8 operations4 paths11 schemas2 DELETE3 GET2 POST1 PUT
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 8
Across 4 paths, the API surfaces 8 operations — 2 DELETE, 3 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are Contact (8 properties), PaginationMeta (6 properties), FieldValue (5 properties), ContactInput (5 properties). Each schema is shown below with its type and property counts.
BulkUpsertResult
object
The outcome of a bulk upsert operation.
4 properties
ErrorObject
object
The compact error shape returned for authentication, authorization and conflict errors.
1 property
FieldValue
object
A single field value belonging to a contact.
5 properties
PaginationMeta
object
Pagination metadata describing the current result window.
6 properties
ContactDetail
object
A contact with its associated field values, returned when retrieving a single contact.
FieldValuesInput
object
The payload used to replace a contact's field values.
1 property1 required
ContactInput
object
The payload used to create or upsert a contact.
5 properties3 required
HttpError
object
The error shape returned for rate-limit (429) errors.
2 properties
FieldType
string
The data type of a field.
Contact
object
A contact as returned in list and create responses.
8 properties
ErrorList
object
The error shape returned for validation and not-found errors.
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
