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

Affinda Organizations API

Manage the top-level organization account — read and update organization details. Organizations contain users, billing, document types, and workspaces. Per-user limit of 3 API keys.

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

Tagged areas include Organization, Administration, and Account. The published artifact set on APIs.io includes API documentation and an OpenAPI specification.

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

Requests are made against a single base URL, https://{region}.affinda.com.

2 operations 2 paths 6 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
3.0.0
Server
https://{region}.affinda.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Affinda Organizations API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — Basic authentication using an API key, e.g. {Authorization: Bearer aff0bb4fbdf97b7e4111ff6c0015471094155f91}. You can find your API key within the Settings pag…

Paths & Operations 2

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

Organizations 2
GET
/v3/organizations
Get list of all organizations
getAllOrganizations → 200400401default
GET
/v3/organizations/{identifier}
Get detail of an organization
getOrganization 1 param → 200400401default

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Organization (8 properties), ThemeConfig (4 properties), PaletteColorOptions (4 properties), RequestError (2 properties). Each schema is shown below with its type and property counts.

Organization
object
8 properties
PaletteColorOptions
object
4 properties 1 required
OrganizationRole
string
ThemeConfig
object
4 properties
RequestError
object
2 properties 2 required
Organization_properties-identifier
string
Uniquely identify an organization.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

affinda-organizations-api-openapi.yml Raw ↑

Other APIs Affinda publishes across the network.

Affinda Documents API
Affinda Document Types API
Affinda Workspaces API
Affinda Data Sources API
Affinda Annotations API
Affinda Validation Results API
Affinda Tags API
Affinda Usage API
Affinda Webhooks API
Affinda Search and Match API
Affinda Add x-hidden to endpoints API
Affinda Deprecated End Points API