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 Add x-hidden to endpoints API

Hidden endpoints not intended for public use.These endpoints include Splitting, Extractor, Organization, and Workspace Memberships & Usage functionality.

Affinda Add x-hidden to endpoints API is one of 16 APIs that Affinda publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Add x-hidden to endpoints. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 4 paths, and defines 17 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.

7 operations 4 paths 17 schemas 2 DELETE2 GET2 PATCH1 POST

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 Add x-hidden to endpoints 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 7

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

Add x-hidden to endpoints 7

Hidden endpoints not intended for public use. These endpoints include Splitting, Extractor, Organization, and Workspace Memberships & Usage functionality.

POST
/v3/organizations
Create a new organization
createOrganization body → 201400401default
PATCH
/v3/organizations/{identifier}
Update an organization
updateOrganization 1 param body → 200400401default
DELETE
/v3/organizations/{identifier}
Delete an organization
deleteOrganization 1 param → 204400401default
GET
/v3/organization_memberships
Get list of all organization memberships
getAllOrganizationMemberships 4 params → 200400401default
GET
/v3/organization_memberships/{identifier}
Get detail of an organization membership
getOrganizationMembership 1 param → 200400401default
PATCH
/v3/organization_memberships/{identifier}
Update an organization membership
updateOrganizationMembership 1 param body → 200400401default
DELETE
/v3/organization_memberships/{identifier}
Delete an organization membership
deleteOrganizationMembership 1 param → 204400401default

Schemas 17

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

resthookSignatureKey
string
Used to sign webhook payloads so you can verify their integrity.
Organization_properties-name
string
ThemeConfig
object
4 properties
RequestError
object
2 properties 2 required
avatar
string
Upload avatar for the organization.
Identifier
string
A random string that uniquely identify the resource.
PaginatedResponse
object
3 properties 1 required
Organization_properties-identifier
string
Uniquely identify an organization.
OrganizationCreate
object
3 properties 1 required
OrganizationRole
string
OrganizationMembershipUpdate
object
1 property
validationToolConfig
object
Configuration of the embeddable validation tool.
17 properties
User
object
5 properties
OrganizationUpdate
object
4 properties
Organization
object
8 properties
OrganizationMembership
object
4 properties 4 required
PaletteColorOptions
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

affinda-add-x-hidden-to-endpoints-api-openapi.yml Raw ↑

Other APIs Affinda publishes across the network.

Affinda Documents API
Affinda Document Types API
Affinda Workspaces API
Affinda Organizations 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 Deprecated End Points API