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

Ntropy categories API

The categories API from Ntropy — 2 operation(s) for categories.

Ntropy categories API is one of 16 APIs that Ntropy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

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

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

3 operations 2 paths 7 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.ntropy.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Ntropy categories API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Api-Key (APIKeyHeader).

Paths & Operations 3

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

categories 3
POST
/v3/categories/{id}
Set a custom set of categories
custom-categories-post-v-3-categories-id-post 2 params body → 200422
GET
/v3/categories/{id}
Retrieve category set
get-category-set-v-3-categories-id-get 2 params → 200422
POST
/v3/categories/{id}/reset
Reset category set to original values
delete-custom-category-set-v-3-categories-id-reset-post 2 params → 200422

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are ValidationError (3 properties), CategorySet (2 properties), CustomCategorySet (2 properties), HTTPValidationError (1 property). Each schema is shown below with its type and property counts.

ValidationErrorLocItems
HTTPValidationError
object
1 property
ValidationError
object
3 properties 3 required
CustomCategorySet
object
2 properties 2 required
CategorySet
object
2 properties 2 required
Categories_get_category_set_v3_categories__id__get_Response_200
V3CategoriesIdResetPostResponsesContentApplicationJsonSchema

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ntropy-categories-api-openapi.yml Raw ↑

Other APIs Ntropy publishes across the network.

Ntropy Account Holder API
Ntropy accountHolders API
Ntropy Bank statements API
Ntropy bankStatements API
Ntropy batches API
Ntropy Enrichment API
Ntropy entities API
Ntropy Labels API
Ntropy Misc API
Ntropy personalization API
Ntropy recurrence API
Ntropy Reporting API