homechevron_rightDocschevron_rightAPI Referencechevron_rightNotehub APIchevron_rightOrganization API - Notehub API Reference

Organization API

The Notehub Organization API provides RESTful methods that can be used to retrieve data related to Notehub Organizations.

NameHTTP Request
Get OrganizationsGET /v1/organizations
Get OrganizationGET /v1/organizations/{organizationUID}
Get Organization Balance HistoryGET /v1/organizations/{organizationUID}/balance-history

Get Organizations Notehub

Get an array of Notehub Organizations.

HTTP Method:GET
URL:https://api.notefile.net/v1/organizations
Minimum Notehub project-level role:viewer
Required HTTP Headers:Authorization: Bearer <token>, where the token is a valid authentication token.
Arguments
None
curl -X GET
    -L 'https://api.notefile.net/v1/organizations'
    -H 'Authorization: Bearer <access_token>'
Response Members

uid

string

The globally-unique identifier of the organization.

name

string

The name of the organization.

role

The role the authenticated user has within the organization:

org_admin Full administrative privileges to purchase credits, set up auto-recharge, and invite members.

billing_manager Access to billing is granted, but the ability to invite members is restricted.

project_creator Access is limited to creating projects within an organization.

org_member General access to the organization without billing or project-creation privileges.

Example Response
{
  "organizations": [
    {
      "uid": "00000000-0000-0000-0000-000000000000",
      "name": "Jane's Organization",
      "role": "org_admin"
    },
    {
      "uid": "00000000-0000-0000-0000-000000000000",
      "name": "John's Organization",
      "role": "billing_manager"
    }
  ]
}

Get Organization Notehub

Get information about a single Notehub Organization by its organizationUID.

HTTP Method:GET
URL:https://api.notefile.net/v1/organizations/{organizationUID}
Path Parameters:
  • organizationUID - The globally-unique identifier of a Notehub organization.
Minimum Notehub project-level role:viewer
Required HTTP Headers:Authorization: Bearer <token>, where the token is a valid authentication token.
Arguments
None
curl -X GET
    -L 'https://api.notefile.net/v1/organizations/<organizationUID>'
    -H 'Authorization: Bearer <access_token>'
Response Members

uid

string

The globally-unique identifier of the organization.

name

string

The name of the organization.

owner

string

The name of the owner of the organization.

contact_uid

string

The globally-unique identifier of the organization's primary contact.

email

string

The email address of the organization's primary contact.

suspended

boolean

Whether or not the organization is suspended.

plan

object

An object containing the organization's current plan information.

plan.type

string

The type of plan associated with this organization. One of "Enterprise" or "Essentials".

plan.current_balance

integer

The event capacity remaining on the plan.

plan.start_date

string (date)

The start date of the current plan period.

plan.end_date

string (date)

For enterprise organizations, the end date of the current plan period.

plan.event_capacity

integer

For enterprise organizations, the total event capacity for the current plan period.

Example Response
{
  "uid": "00000000-0000-0000-0000-000000000000",
  "name": "Jane's Organization",
  "owner": "jane@example.com",
  "contact_uid": "00000000-0000-0000-0000-000000000000",
  "email": "jane@example.com",
  "suspended": false,
  "plan": {
    "type": "Essentials",
    "current_balance": 5000,
    "start_date": "2026-01-01T00:00:00Z"
  }
}

Get Organization Balance History Notehub

Get the event balance history for a Notehub Organization.

HTTP Method:GET
URL:https://api.notefile.net/v1/organizations/{organizationUID}/balance-history
Path Parameters:
  • organizationUID - The globally-unique identifier of a Notehub organization.
Minimum Notehub project-level role:viewer
Required HTTP Headers:Authorization: Bearer <token>, where the token is a valid authentication token.
Arguments

startDate

string (optional)

Start date for filtering results, in ISO 8601 date-time format.

endDate

string (optional)

End date for filtering results, in ISO 8601 date-time format.

curl -X GET
    -L 'https://api.notefile.net/v1/organizations/<organizationUID>/balance-history'
    -H 'Authorization: Bearer <access_token>'
Response Members

data

array of objects

An array of objects containing event balance history. Each object contains the following fields:

data.period

string (date)

The start of the time period for this balance record.

data.remaining_event_capacity

integer

The number of events remaining in the organization's capacity at the end of this period.

data.total_event_capacity_used

integer

The total number of events consumed from the organization's capacity during this period.

Example Response
{
  "data": [
    {
      "period": "2026-01-01T00:00:00Z",
      "remaining_event_capacity": 15000,
      "total_event_capacity_used": 5000
    },
    {
      "period": "2026-01-02T00:00:00Z",
      "remaining_event_capacity": 10000,
      "total_event_capacity_used": 5000
    },
    {
      "period": "2026-01-03T00:00:00Z",
      "remaining_event_capacity": 5000,
      "total_event_capacity_used": 5000
    }
  ]
}