API keys

You can authorize your access using the API keys. All API keys have the same permissions and full account access. The API key can be added to the 'authorization' request header to authorize the request. Each API key has the following fields:

Attributes	Type	Description
id	string	The unique ID of the API key.
label	string	The label for this API key. It may be duplicated with other labels.
key	string	The alpha-numeric API key.
createdAt	string	The timestamp when this instance was created.

In JSON Format

Example
{
  "workspaceId": 12,
  "id": "67642054b6cc2888638e4600",
  "key": "e108d6e3-****-****-****-************",
  "label": "Dev API Key",
  "createdAt": "2024-12-19T13:32:04.009Z",
}

You can check our playground to explore and interact with GraphQL APIs easily and intuitively with real-time documentation.

List API keys

This endpoint returns the API keys for a specific workspace. It uses the following parameters:

Parameter	Type	Description
workspaceId	number	The workspace ID.
label	string	Filter the result by label using a string pattern

Request & Response

POST https://gateway.bcrumbs.net/core/gq

Example
query apiKeys($input: ApiKeysInput!) {
    apiKeys(input: $input) {
        nodes {
           workspaceId
           id
           key
           label
           createdAt
        }
    }
}

input ApiKeysInput {
    workspaceId: Int!
    label: String
}

The query above returns JSON structured like this:

Example
{
  "nodes": [
    {
      "workspaceId": 12,
      "id": "67642054b6cc2888638e4600",
      "key": "e108d6e3-****-****-****-************",
      "label": "Dev API Key",
      "createdAt": "2024-12-19T13:32:04.009Z",
    },
    ...
  ]
}

Generate an API key

This endpoint lets you generate an API Key.

To get the first API key, visit the API Keys on your dashboard, select a suitable name for the key, and click the "Save" button. The dashboard will navigate to the API Keys listing page, where you can find your key.

Attributes	Type	Description
workspaceId	number	The workspace ID.
label	string	The label for this API key. It may be duplicated with other labels.

Request & Response

POST https://gateway.bcrumbs.net/core/gq

Example
mutation genApiKey($input: ApiKeyGenInput!) {
    genApiKey(input: $input) {
        workspaceId
        id
        key
        label
        createdAt
    }
}

input ApiKeyGenInput {
    workspaceId: Int!
    label: String!
}

The mutation above returns JSON structured like this:

Example
{
  "workspaceId": 12,
  "id": "67642054b6cc2888638e4600",
  "key": "e108d6e3-****-****-****-************",
  "label": "Dev API Key",
  "createdAt": "2024-12-19T13:32:04.009Z",
}

Delete an API key

This endpoint lets you delete an API key.

Attributes	Type	Description
id	string	The unique ID of the API key.
workspaceId	number	The workspace ID.

Request & Response

POST https://gateway.bcrumbs.net/core/gq

Example
mutation deleteApiKey($input: ApiKeyDeleteInput!) {
    deleteApiKey(input: $input) {
        workspaceId
        id
        key
        label
        createdAt
    }
}

input ApiKeyDeleteInput {
    workspaceId: Int!
    id: ID!
}

The commands above return JSON structured like this:

Example
{
  "workspaceId": 12,
  "id": "67642054b6cc2888638e4600",
  "key": "e108d6e3-****-****-****-************",
  "label": "Dev API Key",
  "createdAt": "2024-12-19T13:32:04.009Z",
}