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

iconik Metadata API

Custom metadata fields, views, and values.

iconik Metadata API is one of 6 APIs that iconik publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

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

Requests are made against 2 base URLs: https://app.iconik.io/API, https://eu.iconik.io/API.

5 operations 3 paths 2 schemas 3 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://app.iconik.io/API/assets/v1
Authentication
API Key, API Key
Contact
Resource Areas
1

Authentication & Security 2

iconik Metadata API declares 2 security schemes for authenticating requests. An API key is passed in the header as App-ID (appId). An API key is passed in the header as Auth-Token (authToken). By default, every request must be authenticated.

  • appId — The iconik application ID generated in the web UI.
  • authToken — The iconik auth token paired with the application ID.

Paths & Operations 5

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

Metadata 5

Custom metadata fields, views, and values.

GET
/metadata/v1/fields/
List metadata fields
listMetadataFields → 200
POST
/metadata/v1/fields/
Create a metadata field
createMetadataField body → 201
GET
/metadata/v1/views/
List metadata views
listMetadataViews → 200
GET
/metadata/v1/assets/{asset_id}/views/{view_id}/
Get asset metadata for a view
getAssetMetadata 2 params → 200
PUT
/metadata/v1/assets/{asset_id}/views/{view_id}/
Set asset metadata for a view
putAssetMetadata 2 params body → 200

Schemas 2

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

MetadataValues
object
1 property
MetadataField
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

iconik-metadata-api-openapi.yml Raw ↑

Other APIs iconik publishes across the network.

iconik Assets API
iconik Collections API
iconik Files API
iconik Jobs API
iconik Search API