Retrieve an API - Unkey Docs

GET

apis.getApi

curl --request GET \
  --url https://api.unkey.dev/v1/apis.getApi \
  --header 'Authorization: Bearer <token>'

{
  "id": "key_1234",
  "workspaceId": "ws_1234",
  "name": "Unkey - Production"
}

Changelog

Date	Changes
Dec 06 2023	Introduced endpoint

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

apiId

string

required

The id of the api to fetch

200 - application/json

string

required

The id of the key

workspaceId

string

required

The id of the workspace that owns the api

name

string

The name of the api. This is internal and your users will not see this.

Was this page helpful?

curl --request GET \
  --url https://api.unkey.dev/v1/apis.getApi \
  --header 'Authorization: Bearer <token>'

{
  "id": "key_1234",
  "workspaceId": "ws_1234",
  "name": "Unkey - Production"
}