Get current workspace consumption and billing information.
curl --request GET \
--url https://api.edges.run/v1/workspaces \
--header 'X-API-Key: <api-key>'const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.edges.run/v1/workspaces', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.edges.run/v1/workspaces"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"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
}Workspaces
Get a Workspace
Retrieve your workspace’s plan, credit balance and billing period.
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>'const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.edges.run/v1/workspaces', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.edges.run/v1/workspaces"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"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
}Agent skill
edges-get-workspace — ready-made instructions for coding agents calling this endpoint.Authorizations
API key required for authentication. Add your API key in the X-API-Key header.
Response
Successfully retrieved the current workspace consumption.
The name of the workspace (maximum 55 characters)
Maximum string length:
55