Generate and manage API keys

Last updated: August 16, 2026

An API key is the credential your systems use to call Nash. You create, scope, and revoke keys on the API Keys page under Settings ▸ Connections ▸ API Keys. The page subtitle reads Access and manage your API keys to automate shipping.

This page covers the portal actions: generating a key, scoping it, copying the one-time secret, editing its scopes, and revoking it. For how to actually use a key — the authorization header, base URLs, endpoints, and payloads — see the Nash developer docs.

Note

The Connections group is hidden for provider organizations, so API keys only appear for operator orgs.

Generate a key

Select Generate Key to open the Generate an API Key drawer, then fill in:

  • Key Name — required. Name the key after the system or integration that will hold it, so you can tell your keys apart later.
  • Description — optional. A longer note about what the key is for.
  • Organizations — required. Choose one or more of the organizations you have access to. Your signed-in organization is preselected. A single key can carry access across several organizations at once.
  • Feature Groups — the scopes the key grants. Scopes are grouped by feature area, and you grant Read and/or Write per group. For the full model, see API key scopes and permissions.

Save stays disabled until the key has a name and at least one organization.

Copy the one-time secret

When you save, the drawer replaces the form with the new key. This is the only time Nash shows the full secret — the on-screen warning reads Make sure you copy this API key now. This is the only time you will see it unencrypted.

Warning

Copy the key and store it in your secret manager before you close the drawer. Nash keeps only a hash and genuinely cannot show the full key again. If you lose it, your only path is to generate a new key and delete the old one.

After this, the keys table shows only a masked Partial Key fragment, never the full secret.

Read the keys table

The table lists every key you can see, with these columns:

Column What it shows
Name The key's name.
Description The note you gave it; long text is truncated with a hover tooltip.
Partial Key A masked fragment of the key — enough to recognize it, not to use it.
Organizations The organizations the key applies to; a +N badge and hover tooltip list the rest.
Created At When the key was generated.

Note

If you have the Owner role you see every key created across the organization. Other roles see a narrower set — the keys you have access to.

Edit a key's scopes

Select a row to open the Edit your API Key drawer. You can change the name, description, organizations, and feature-group scopes, then Save. Editing scopes does not change the secret — the key keeps working with its new permissions.

Revoke a key

To revoke a key, open its actions menu (⋮) in the Actions column and choose Delete.

Warning

Delete revokes the key immediately, with no confirmation step and no undo. Anything still authenticating with that key stops working at once. If the key is in active use, line up its replacement first.

There is no rotate or regenerate control and no expiry setting — the model is generate a new key, then delete the old one.

Using your key

Authorization headers, base URLs, endpoints, request and response payloads, the async and bulk order APIs, and rate limits all live in the developer docs. See https://docs.usenash.com.

Related