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 get API

The get API from Athenian — 4 operation(s) for get.

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

The published artifact set on APIs.io includes an OpenAPI specification.

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

4 operations 4 paths 40 schemas 1 GET3 POST

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 get 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 4

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

get 4
GET
/get/contributors/{id}
List all the contributors belonging to the specified account.
get_contributors 1 param → 200404422424
POST
/get/jira_issues
Retrieve Jira issues by key.
get_jira_issues body → 200400
POST
/get/pull_requests
List pull requests by repository and number.
get_prs body → 200400403404422424
POST
/get/releases
List releases by repository and name.
get_releases body → 200400403404422424

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are PullRequest (29 properties), JIRAEpicIssueCommon (19 properties), FilteredRelease (13 properties), DeploymentNotification (8 properties). Each schema is shown below with its type and property counts.

PullRequestStage
string
PR's modelled lifecycle stages. wip: The PR is a work-in-progress: no reviews, no review requests, not closed. reviewing: The PR is going through a review proc…
PullRequestEvent
string
PR's modelled lifecycle events. created: The PR was opened. committed: Somebody pushed a commit to the PR. reviewrequested: Somebody requested a PR review. rev…
StageTimings
object
Time spent by the PR in each pipeline stage. The deployments are independent of the releases. If the release happens before the deployment, the deployment time…
5 properties 1 required
RepositoryID
string
Repository name which uniquely identifies any repository in any service provider. The format matches the repository URL without the protocol part. No ".git" sh…
IncludedDeployments
object
Mentioned deployments.
1 property
JIRAUser
object
Details about a JIRA user.
4 properties 3 required
ReleasedPullRequest
object
Details about a pull request listed in /filter/releases.
7 properties 6 required
IncludedNativeUsers
object
Mentioned GitHub users.
1 property 1 required
GetJIRAIssuesRequest
object
Request body for the getjiraissues operation. Declaration of which issues the user wants to retrieve.
3 properties 2 required
MissingSettingsError
GenericError
object
5 properties 3 required
PullRequestParticipant
object
Developer and their role in the PR.
2 properties 2 required
DeveloperID
string
User name which uniquely identifies any developer on any service provider. The format matches the profile URL without the protocol part.
IncludedJIRAIssues
object
Mentioned JIRA issues.
1 property
Contributors
array
List of contributors.
PullRequest
object
Details of a pull request. All the attributes, stats and events correspond to "today", not dateto, except for the PR stages wip, reviewing, merging, releasing,…
29 properties 14 required
JIRAIssue
ReleaseNames
object
Repository name and a list of release names in that repository.
2 properties 2 required
PullRequestLabel
object
Pull request label.
3 properties 2 required
PullRequestNumbers
object
Repository name and a list of PR numbers in that repository.
2 properties 2 required
Color
string
RGB 24-bit color in hex.
DeploymentConclusion
string
State of the completed deployment. Case-insensitive.
TimeDuration
string
Time duration value.
JIRAComment
object
3 properties 3 required
LinkedJIRAIssue
object
Brief details about a JIRA issue.
5 properties 3 required
ReleaseSet
object
Release metadata and contributor user details.
2 properties
GetPullRequestsRequest
object
Request body of /get/pullrequests. Declaration of which PRs the user wants to list. The order of the requested PRs will be preserved in the response.
3 properties 2 required
DeployedComponent
object
Definition of the deployed software unit.
2 properties 2 required
NoSourceDataError
GetReleasesRequest
object
Request body of /get/releases. Declaration of which releases the user wants to list.
2 properties 2 required
PullRequestSet
object
List of pull requests together with the participant profile pictures.
2 properties 2 required
InvalidRequestError
DeploymentNotification
object
Push message about a deployment. We remove unresolved components after 24h.
8 properties 5 required
JIRAEpicIssueCommon
object
Common properies if a JIRA issue or epic.
19 properties 12 required
GetJIRAIssuesInclude
string
Additional information to include in the response for the getjiraissues operation: comments: include comments for every issue; returned issues will include a c…
Contributor
object
Details about a developer who contributed to some repositories owned by the account.
5 properties 1 required
GetJIRAIssuesResponse
object
Response for the getjiraissues operation.
2 properties 1 required
FilteredRelease
object
Various information about a repository release.
13 properties 12 required
DeploymentLabels
object
Arbitrary key-value metadata that associates with the deployment.
IncludedNativeUser
object
User traits such as the avatar URL.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

athenian-get-api-openapi.yml Raw ↑

Other APIs Athenian publishes across the network.

Athenian align API
Athenian events API
Athenian filter API
Athenian histograms API
Athenian integrations API
Athenian metrics API
Athenian pagination API
Athenian registration 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 get 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.