Skip to main content
GET
/
workspaces
Get current workspace consumption and billing information.
curl --request GET \
  --url https://api.edges.run/v1/workspaces \
  --header 'X-API-Key: <api-key>'
{
  "name": "Example Workspace",
  "uid": "123e4567-e89b-12d3-a456-426614174000",
  "credits_left": 50,
  "credits_max": 100,
  "credits_used": 50,
  "plan_name": "Growth",
  "current_month_start": "2023-10-01T00:00:00Z",
  "current_month_end": "2023-10-31T23:59:59Z",
  "identities_included": 10,
  "identities_synced": 2,
  "identities_remaining": 8
}

Documentation Index

Fetch the complete documentation index at: https://docs.edges.run/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

API key required for authentication. Add your API key in the X-API-Key header.

Response

Successfully retrieved the current workspace consumption.

​
name
string
required

The name of the workspace (maximum 55 characters)

Maximum string length: 55
​
uid
string<uuid>
​
credits_left
number
default:0
​
credits_max
integer
default:0
​
credits_used
number
default:0
​
plan_name
string | null
​
current_month_start
string<date-time> | null
​
current_month_end
string<date-time> | null
​
identities_included
integer
default:0
​
identities_synced
integer
default:0
​
identities_remaining
integer
default:0