Skip to main content
GET
View API key details

When to use this endpoint

You want the name and creation date of one API key, identified by its prefix.

Example request

cURL
Set KEY_PREFIX to the prefix of the key, and FORAGER_API_KEY and FORAGER_ACCOUNT_ID as in the quickstart.

Example response

200 (illustrative values)

Credits

The credit cost of this operation is not documented yet. See API credits and pricing.

Authorizations

X-API-KEY
string
header
required

Path Parameters

prefix
string
required

Response

Declares JSON representation of UserAPIKey model instances.

prefix
string
required
read-only
created
string<date-time>
required
read-only
name
string

A free-form name for the API key. Need not be unique. 50 characters max.

Maximum string length: 50
Last modified on November 1, 2026