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 Organization API - Invitation API

The Organization API - Invitation API from Affinda — 3 operation(s) for organization api - invitation.

Affinda Organization API - Invitation 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 API - Invitation. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 3 paths, and defines 15 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 3 paths 15 schemas 1 DELETE3 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 Organization API - Invitation 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 3 paths, the API surfaces 7 operations — 1 DELETE, 3 GET, 2 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Organization API - Invitation 7
GET
/v3/invitations
Get list of all invitations
getAllInvitations 5 params → 200400401default
POST
/v3/invitations
Create a new invitation
createInvitation body → 201400401default
GET
/v3/invitations/{identifier}
Get detail of an invitation
getInvitation 1 param → 200400401default
PATCH
/v3/invitations/{identifier}
Update an invitation
updateInvitation 1 param body → 200400401default
DELETE
/v3/invitations/{identifier}
Delete an invitation
deleteInvitation 1 param → 204400401default
GET
/v3/invitations/token/{token}
Get detail of an invitation by token
getInvitationByToken 1 param → 200400default
PATCH
/v3/invitations/token/{token}
Respond to an invitation
respondToInvitation 1 param body → 200400401default

Schemas 15

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

InvitationStatus
string
Invitation
object
9 properties
ThemeConfig
object
4 properties
RequestError
object
2 properties 2 required
properties-email
string
The email which the invitation is sent to.
InvitationResponse
object
1 property
PaginatedResponse
object
3 properties 1 required
Organization_properties-identifier
string
Uniquely identify an organization.
Invitation_properties-identifier
string
Uniquely identify an invitation.
OrganizationRole
string
User
object
5 properties
InvitationUpdate
object
1 property
Organization
object
8 properties
InvitationCreate
object
3 properties 3 required
PaletteColorOptions
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

affinda-organization-api-invitation-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 Add x-hidden to endpoints API