List All Open API Keys and Profile for Your Workspace

Use this endpoint to retrieve every Open API key in your workspace alongside the organization’s API profile. The profile includes credit rates and usage limits that apply to all jobs submitted through the API.

This endpoint uses session cookie authentication (plangrep_session). It is used by the Plangrep app’s API settings page and does not accept a bearer API key.

Endpoint

GET https://plangrep.com/api/open-api/keys

Authentication

Method	Value
Cookie	`plangrep_session=YOUR_SESSION_COOKIE`

Parameters

No query or path parameters.

Response

200 OK Returns an OpenApiKeyListResponse object.

keys

OpenApiKey[]

required

All API keys belonging to the current workspace.

Show OpenApiKey fields

string

Unique identifier for the API key.

label

string

Human-readable name assigned to the key at creation.

keyPrefix

string

The first few characters of the plaintext key, used for identification. The full key is never returned after creation.

scopes

OpenApiKeyScope[]

Permissions granted to this key. Possible values: jobs:read, jobs:write, artifacts:read.

createdByUserId

string

ID of the workspace user who created this key.

hashVersion

string

Internal version of the hashing algorithm used to store this key.

createdAt

string

ISO 8601 timestamp of when the key was created.

expiresAt

string | null

ISO 8601 timestamp of when the key expires, or null if it never expires.

lastUsedAt

string | null

ISO 8601 timestamp of the most recent successful request made with this key, or null if it has never been used.

lastUsedIp

string | null

IP address of the most recent request made with this key, or null if it has never been used.

revokedAt

string | null

ISO 8601 timestamp of when the key was revoked, or null if it is still active.

profile

OpenApiProfile

required

Your organization’s API configuration and credit rates.

Show OpenApiProfile fields

documentCreditsPerPage

integer

Number of credits consumed per page when processing a document (e.g., a specification). Minimum: 1.

drawingCreditsPerPage

integer

Number of credits consumed per page when processing a drawing. Minimum: 1.

enabled

boolean

Whether the Open API is enabled for this organization. Keys cannot be used while this is false.

jobPageLimit

integer

Maximum number of pages allowed in a single job submission. Minimum: 1.

retentionDays

integer

Number of days job results and artifacts are retained before automatic deletion. Minimum: 1.

updatedAt

string

ISO 8601 timestamp of the last time this profile was updated.

Use the profile object to display current credit rates and limits to your users before they submit jobs. The drawingCreditsPerPage and documentCreditsPerPage fields let you estimate costs upfront.

Example

curl https://plangrep.com/api/open-api/keys \
  -H "Cookie: plangrep_session=YOUR_SESSION_COOKIE"

Example Response

{
  "keys": [
    {
      "id": "key_01hx3z...",
      "label": "Production Integration",
      "keyPrefix": "pgk_live_abc1",
      "scopes": ["jobs:read", "jobs:write", "artifacts:read"],
      "createdByUserId": "usr_01hx3y...",
      "hashVersion": "v1",
      "createdAt": "2024-11-01T10:00:00Z",
      "expiresAt": null,
      "lastUsedAt": "2025-01-15T08:42:00Z",
      "lastUsedIp": "203.0.113.42",
      "revokedAt": null
    }
  ],
  "profile": {
    "documentCreditsPerPage": 2,
    "drawingCreditsPerPage": 5,
    "enabled": true,
    "jobPageLimit": 500,
    "retentionDays": 30,
    "updatedAt": "2024-10-15T12:00:00Z"
  }
}

​Endpoint

​Authentication

​Parameters

​Response

​Example

​Example Response

Endpoint

Authentication

Parameters

Response

Example

Example Response