How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Athenian registration API

The registration API from Athenian — 6 operation(s) for registration.

Athenian registration API is one of 15 APIs that Athenian publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Registration. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 6 paths, and defines 11 schemas. It is described by OpenAPI 3.2.0, at version 2.1.86.

Requests are made against a single base URL, {{ server_url }}/v1.

6 operations 6 paths 11 schemas 4 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.1.86
Base URL
https://api.athenian.co/v1
Authentication
API Key, HTTP Bearer
License
CC-BY-4.0
Resource Areas
1

Authentication & Security 2

Athenian registration API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-API-Key (apiKeyAuth). It accepts HTTP bearer tokens (JWT) (bearerAuth).

  • apiKeyAuth — Authorization by the value of X-API-Key header aka API token. The tokens are user- and account-specific. Create them by calling /token/create. The server autom…
  • bearerAuth — Regular JSON Web Token authorization powered by Auth0. The server expects an Authorization: Bearer header and checks by sending it to Auth0. Visit [{{ serverur…

Paths & Operations 6

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

registration 6
PUT
/invite/accept
👤 Accept the account membership invitation and finish registration. The user must be already authorized in Auth0.
accept_invitation body → 200400403404409422
POST
/invite/check
Given an invitation URL, get its type (admin or regular account member) and find whether it is correctly formed and is enabled or disabled.
check_invitation body → 200
GET
/invite/generate/{id}
👤 Create an account invitation link for regular users. The caller must be an admin of the specified account. The link is persistent, so multiple calls return the same result.
gen_user_invitation 1 param → 200403404
GET
/invite/jira/{id}
👤 Generate a JIRA integration installation link. The caller must be an admin of the specified account.
gen_jira_link 1 param → 200403404
GET
/invite/jira_progress/{id}
Return the current JIRA installation progress in Athenian.
eval_jira_progress 1 param → 200404422
GET
/invite/progress/{id}
Return the current GitHub installation progress in Athenian.
eval_metadata_progress 1 param → 200404422

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are User (9 properties), AccountStatus (6 properties), GenericError (5 properties), InstallationProgress (5 properties). Each schema is shown below with its type and property counts.

InvalidRequestError
TableFetchingProgress
object
Used in InstallationProgress.tables to indicate how much data has been loaded in each DB table.
3 properties 3 required
InvitedUser
object
Details about the user who has accepted an invitation.
2 properties 2 required
GenericError
object
5 properties 3 required
AcceptedInvitation
object
Request for entering the product.
3 properties 1 required
User
object
User details. "updated" and "accounts" are populated only for the calling user.
9 properties 3 required
AccountStatus
object
Status of the user's account membership.
6 properties 6 required
InvitationLink
object
Product invitation URL.
1 property 1 required
InvitationCheckResult
object
3 properties 1 required
NoSourceDataError
InstallationProgress
object
Status of fetching data to Athenian. GitHub progress always returns owner and repositories.
5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

athenian-registration-api-openapi.yml Raw ↑

Other APIs Athenian publishes across the network.

Athenian align API
Athenian events API
Athenian filter API
Athenian get API
Athenian histograms API
Athenian integrations API
Athenian metrics API
Athenian pagination API
Athenian reposet API
Athenian security API
Athenian settings API
Athenian team API
Where this information came from

This is an independent, third-party profile of Athenian registration API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.