Get credit usage for agents in a space

curl --request GET \
  --url https://api.notion.com/admin/v1/spaces/{space_id}/agents/credit_usage \
  --header 'Authorization: Bearer <token>' \
  --header 'Notion-Version: <notion-version>'

import requests

url = "https://api.notion.com/admin/v1/spaces/{space_id}/agents/credit_usage"

headers = {
    "Notion-Version": "<notion-version>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Notion-Version': '<notion-version>', Authorization: 'Bearer <token>'}
};

fetch('https://api.notion.com/admin/v1/spaces/{space_id}/agents/credit_usage', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.notion.com/admin/v1/spaces/{space_id}/agents/credit_usage",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Notion-Version: <notion-version>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.notion.com/admin/v1/spaces/{space_id}/agents/credit_usage"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Notion-Version", "<notion-version>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.notion.com/admin/v1/spaces/{space_id}/agents/credit_usage")
  .header("Notion-Version", "<notion-version>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.notion.com/admin/v1/spaces/{space_id}/agents/credit_usage")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Notion-Version"] = '<notion-version>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "has_more": true,
  "results": [
    {
      "credit_per_billing_period_list": [
        {
          "credits_used": 123,
          "metrics_period_end_ms": 123,
          "metrics_period_start_ms": 123
        }
      ],
      "has_more": true,
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "runs_completed": 123,
      "status": "active",
      "total_credits_used": 123,
      "type": "custom",
      "created_by_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "credit_limit": 123,
      "last_credit_usage_time": 123,
      "name": "<string>",
      "next_cursor": "<string>"
    }
  ],
  "next_cursor": "<string>"
}

{
  "type": "error",
  "code": "validation_error",
  "status": 400,
  "message": "The request body is invalid."
}

{
  "type": "error",
  "code": "unauthorized",
  "status": 401,
  "message": "Unauthorized."
}

{
  "type": "error",
  "code": "forbidden",
  "status": 403,
  "message": "Forbidden."
}

{
  "type": "error",
  "code": "not_found",
  "status": 404,
  "message": "Not found."
}

{
  "type": "error",
  "code": "rate_limited",
  "status": 429,
  "message": "Rate limited."
}

{
  "type": "error",
  "code": "internal_server_error",
  "status": 500,
  "message": "An unexpected error occurred."
}

GET

spaces

{space_id}

agents

credit_usage

Get credit usage for agents in a space

curl --request GET \
  --url https://api.notion.com/admin/v1/spaces/{space_id}/agents/credit_usage \
  --header 'Authorization: Bearer <token>' \
  --header 'Notion-Version: <notion-version>'

import requests

url = "https://api.notion.com/admin/v1/spaces/{space_id}/agents/credit_usage"

headers = {
    "Notion-Version": "<notion-version>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Notion-Version': '<notion-version>', Authorization: 'Bearer <token>'}
};

fetch('https://api.notion.com/admin/v1/spaces/{space_id}/agents/credit_usage', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.notion.com/admin/v1/spaces/{space_id}/agents/credit_usage",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Notion-Version: <notion-version>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.notion.com/admin/v1/spaces/{space_id}/agents/credit_usage"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Notion-Version", "<notion-version>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.notion.com/admin/v1/spaces/{space_id}/agents/credit_usage")
  .header("Notion-Version", "<notion-version>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.notion.com/admin/v1/spaces/{space_id}/agents/credit_usage")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Notion-Version"] = '<notion-version>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "has_more": true,
  "results": [
    {
      "credit_per_billing_period_list": [
        {
          "credits_used": 123,
          "metrics_period_end_ms": 123,
          "metrics_period_start_ms": 123
        }
      ],
      "has_more": true,
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "runs_completed": 123,
      "status": "active",
      "total_credits_used": 123,
      "type": "custom",
      "created_by_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "credit_limit": 123,
      "last_credit_usage_time": 123,
      "name": "<string>",
      "next_cursor": "<string>"
    }
  ],
  "next_cursor": "<string>"
}

{
  "type": "error",
  "code": "validation_error",
  "status": 400,
  "message": "The request body is invalid."
}

{
  "type": "error",
  "code": "unauthorized",
  "status": 401,
  "message": "Unauthorized."
}

{
  "type": "error",
  "code": "forbidden",
  "status": 403,
  "message": "Forbidden."
}

{
  "type": "error",
  "code": "not_found",
  "status": 404,
  "message": "Not found."
}

{
  "type": "error",
  "code": "rate_limited",
  "status": 429,
  "message": "Rate limited."
}

{
  "type": "error",
  "code": "internal_server_error",
  "status": 500,
  "message": "An unexpected error occurred."
}

The organization bot token must have the following scopes:

workflows:read

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Notion-Version

enum<string>

required

The Admin API version to use for this request.

Available options:

2026-06-01

Path Parameters

space_id

string<uuid>

required

Query Parameters

cursor

string

Cursor for the agent page. Nested cursors continue one agent's billing periods through the single-agent endpoint.

page_size

integer

Number of agents per page. Defaults to 100, maximum 100.

Required range: 1 <= x <= 100

include_deleted

enum<string>

Set to "true" to include soft-deleted agents and their retained credit usage; included deleted agents have status "deleted". Omit this parameter or set it to "false" to return only live agents. Permanently deleted tombstones are never returned.

Available options:

false,

true

credit_usage_time_from

string

Epoch ms, inclusive. When either bound is set, an agent is returned only if its latest credit usage is inside the [from, to] window; agents with no in-window usage are excluded entirely, and last_credit_usage_time on each result reflects the most recent credit usage within the window.

credit_usage_time_to

string

Epoch ms, inclusive. See credit_usage_time_from for the window semantics.

Response

has_more

boolean

required

Whether more agents are available.

results

object[]

required

The page of agents with their credit usage, up to 100 agents per request. Every agent starts at its most recent billing period; a nested result's next_cursor paginates that agent's billing periods through the single-agent credit-usage endpoint.

Show child attributes

next_cursor

string

Cursor to pass as cursor on the next request to fetch the next page of agents; omitted when has_more is false.

⌘I