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

Appfire API query methods API

Retrieve objectives, key results, updates, and comments. Use **expand** to include related entities (teams, periods, labels, etc.) instead of IDs only. Authenticate with the **API-Token** header. For team identifiers and the **Teams** API, see **Teams** in the API overview.

Appfire API query methods API is one of 5 APIs that Appfire publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include API query methods. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

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

Requests are made against 4 base URLs: https://okr-ppm-prod.appfire.com, https://eu.okr-ppm-prod.appfire.com, https://au.okr-ppm-prod.appfire.com, https://ca.okr-ppm-prod.appfire.com.

6 operations 6 paths 14 schemas 6 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v2
Base URL
https://timehubjra.7pace.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Appfire API query methods API declares 1 security scheme for authenticating requests. An API key is passed in the header as API-Token (API-Token). By default, every request must be authenticated.

  • API-Token — API authentication token generated from OKR module settings. Send only this header name (API-Token), not Authorization or Authentication.

Paths & Operations 6

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

API query methods 6

Retrieve objectives, key results, updates, and comments. Use expand to include related entities (teams, periods, labels, etc.) instead of IDs only. Authenticate with the API-Token…

GET
/api/v2/api-export/updates
Query updates by entity
fetchUpdatesByEntityId 5 params → 200400401
GET
/api/v2/api-export/updateComments
Query comments on updates
fetchCommentsByUpdateIds 5 params → 200400401
GET
/api/v2/api-export/objectives/byIds
Query objectives by IDs
fetchObjectivesByIds 2 params → 200400401
GET
/api/v2/api-export/objectives/byDate
Query objectives by date range
fetchObjectives 3 params → 200400401
GET
/api/v2/api-export/keyResults/byIds
Query key results by IDs
fetchKeyResultsByIds 2 params → 200400401
GET
/api/v2/api-export/keyResults/byDate
Query key results by date range
fetchKeyResults 3 params → 200400401

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are ApiExportObjective (26 properties), ApiExportKeyResult (25 properties), ApiExportUpdate (10 properties), ApiExportCustomField (9 properties). Each schema is shown below with its type and property counts.

ApiExportBulkUpdate
object
Paginated list of updates
2 properties
ApiExportTeam
object
A team linked to objectives or key results in this export payload
2 properties
ApiExportCustomField
object
Custom field definition
9 properties
ApiExportKeyResult
object
A key result linked to an objective
25 properties
ApiExportProgressDefinition
object
Progress tracking definition for a key result
4 properties
ApiExportOkrType
object
An OKR type definition
4 properties
ApiExportLabel
object
A label used to categorize OKRs
2 properties
ApiExportData
object
Response containing objectives and/or key results with optionally expanded related entities
7 properties
ApiExportBulkUpdateComments
object
Paginated list of update comments
2 properties
ApiExportUnit
object
Unit of measurement for key result progress
2 properties
ApiExportUpdate
object
A status update for an objective or key result
10 properties
ApiExportPeriodAlias
object
A time period for OKRs
4 properties
ApiExportUpdateComment
object
A comment on an update
7 properties
ApiExportObjective
object
An OKR objective
26 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

appfire-api-query-methods-api-openapi.yml Raw ↑

Other APIs Appfire publishes across the network.

BigPicture Cloud Public API
Appfire API update methods API
Appfire Settings API
Appfire Worklogs API
Where this information came from

This is an independent, third-party profile of Appfire API query methods 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.