Skip to content
Space Invoices Documentation

Entity API Keys

Entity API Keys

Manage entity-scoped API keys (ek_* prefix) for userless access to entities.

Endpoints
IntroductionPOST/entities/api-keysGET/entities/api-keysDELETE/entities/api-keys/{id}

The Entity API Key object

object

Attributes

idstring

API key (ek_* prefix for entity-scoped keys)

namestringnullable

Friendly name for the API key

environmentstring

Environment the key is valid for

Possible values: "live", "sandbox"

Other attributes
entity_idstring
created_atstring<date-time>
expires_atstring<date-time>nullable

Create entity API key

POST/entities/api-keys

Create a new entity-scoped API key (ek_* prefix). This key can only access this specific entity.

Request

Header parameters

entity_idstringoptional

Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.

Body parameters

namestringoptional

Friendly name for the API key

Other parameters
ttlintegeroptional
import SpaceInvoices from '@spaceinvoices/js-sdk';

const sdk = new SpaceInvoices('YOUR_API_KEY');

const response = await sdk.entityApiKeys.create({
  name: "string",
  ttl: 0
});

console.log(response);
Response

Returns

idstring

API key (ek_* prefix for entity-scoped keys)

namestringnullable

Friendly name for the API key

Other parameters
entity_idstring
environmentstring
created_atstring<date-time>
expires_atstring<date-time>nullable
json
{
  "id": "ek_sandbox_abc123def456789012345678abcd1234",
  "entity_id": "ent_abc123def456",
  "name": "Dashboard Access",
  "environment": "sandbox",
  "prefix_hint": "ek_sandbox_abc...234",
  "created_at": "2024-01-01T00:00:00.000Z",
  "updated_at": "2024-01-01T00:00:00.000Z",
  "expires_at": null
}

List entity API keys

GET/entities/api-keys

Retrieve all API keys for the current entity. Keys are masked for security.

Request

Header parameters

entity_idstringoptional

Entity ID on which the request is made. Auto-selected when only one entity exists, required when multiple entities exist.

import SpaceInvoices from '@spaceinvoices/js-sdk';

const sdk = new SpaceInvoices('YOUR_API_KEY');

const response = await sdk.entityApiKeys.listEntityApiKeys();

console.log(response);
Response

Returns

dataarray of objects
json
{
  "data": [
    {
      "id": "ek_sandbox_abc123def456789012345678abcd1234",
      "entity_id": "ent_abc123def456",
      "name": "Dashboard Access",
      "environment": "sandbox",
      "prefix_hint": "ek_sandbox_abc...234",
      "created_at": "2024-01-01T00:00:00.000Z",
      "updated_at": "2024-01-01T00:00:00.000Z",
      "expires_at": null
    }
  ]
}

Delete entity API key

DELETE/entities/api-keys/{id}

Permanently delete an entity API key. This action cannot be undone.

Request

Header parameters

entity_idstringoptional

Optional entity ID specifying which entity context to use for this operation.

Path parameters

idstringrequired

Entity API key ID (format: ek_{environment}_{hex})

import SpaceInvoices from '@spaceinvoices/js-sdk';

const sdk = new SpaceInvoices('YOUR_API_KEY');

await sdk.entityApiKeys.delete("ek_sandbox_abc123def456789012345678abcd1234abc123def456789012345678abcd1234");

console.log('Deleted successfully');
Response

Returns

messagestring
json
{
  "message": "API key deleted"
}