Create a new API key

post/v1/api-keys

Request

Base URL: https://api.epicdirectories.com
URL: https://api.epicdirectories.com/v1/api-keys
Auth: HTTP bearer

Request body

namestring required

Name for the API key

directoryIdstring

Restrict the key to a single directory. Accepts either the directory UUID or its slug. Omit for an account-wide key.

scopesstring[] required

Scopes granted to this key. Required — pass [] for a read-only key (published listings only). Known scopes: write (allow POST/PATCH/PUT/DELETE on listings, attributes, terms, snapshots, webhooks); read:drafts (allow read endpoints to surface non-published listings — drafts and hidden); submissions (read/action the anonymous submission queue); reviews (read/moderate the public review and page-comment queues — approving, and replying to a comment, also need write).

expiresAtstring

Expiration date (ISO 8601)

Example request

{
  "name": "Hermes — ConventionGrid",
  "scopes": [
    "write"
  ],
  "expiresAt": "2025-12-31T23:59:59Z"
}

Response

API key created. The full key is only returned once!

Changes

No recorded changes to this operation across all 1 revision of this API.