Skip to content
API docs
Sign inOpen app

API keys

Create an API key

POST/v1/api-keys

Create an API key for the workspace. The key sees only that workspace. A key made by a member limited to some brands sees only those brands. See Brand access.

Body

JSON, with Content-Type: application/json.

  • namestringrequired

    A name to tell the key apart, such as "Zapier".

    1–200 chars

  • workspaceIdstring

    Optional. Your API key already belongs to one workspace.

Response

  • idstringrequired

    The key's id. Use it to revoke the key.

  • namestringrequired

    The name given when the key was made.

  • prefixstringrequired

    The first 7 characters of the key, fk_ and 4 more, to tell keys apart. The key itself is never returned again.

  • createdAtnumberrequired

    When the key was made, in milliseconds since the epoch.

  • lastUsedAtnumber or nullrequired

    When a request last used the key, in milliseconds since the epoch. Null if it was never used.

  • revokedAtnumber or nullrequired

    When the key was revoked, in milliseconds since the epoch. Null while the key works.

  • createdBystring or nullrequired

    The user id of the member who made the key. A key made with another key gets that key's maker. Null when unknown.

  • staffbooleanrequired

    True for a staff key, which may also call staff endpoints. False for every key you make.

  • sourceenum or nullrequired

    What made the key: handoff when an AI handoff made it for its brief. Null for a key made by hand.

  • keystringrequired

    The key itself, starting with fk_. It is returned only in this response, so store it now.

Errors answer with a status and the error shape.