Skip to main content
GET
Get one request the calling credential made
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

Every Platform API response carries a request id in the X-Request-Id header, and every JSON answer also carries it in meta.requestId. The OpenAPI documents and the reference page send one too. This endpoint answers what Forge recorded about a request your credential made, so a client can check a request’s outcome later or join it to its own traces.

Authorization

GET /api/v2/requests/{requestId} requires no permission. Any Platform API credential can call it: a platform API key, a Personal key, or an External Application access token. A request is filed under the credential that made it; every credential of one External Application (its access tokens and its companion key) shares the app’s requests. An id another credential’s request carried, an unknown id, a malformed id and a request older than 30 days all receive the same 404 and code resource_missing, so the endpoint never tells you whether someone else’s request exists. A request that sends any query parameter or a body is refused with 400 and code bad_request.

Response

Forge never records a request’s body, query string, IP address or headers. Records are kept for 30 days. A record is written just after its response, so a lookup made at once may answer 404 until it lands.

Example

A refused request’s record names why it was refused:

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Path Parameters

requestId
string
required

The request's meta.requestId, as req_ and 16 lowercase hex digits.

Pattern: ^req_[0-9a-f]{16}$

Response

The request's record

data
object
required
meta
object
required