API Reference
Log In
API Reference

List Organizations

get
https://api.revenium.ai/profitstream/v2/api/organizations

Retrieve a paginated list of organizations within a tenant. Note on scope: Organizations are tenant-scoped (a tenant contains one or more teams; each team can reference organizations defined at the tenant level). For this reason, this endpoint requires tenantId, not the teamId used by team-scoped endpoints (jobs, subscriptions, products, etc.). Tenant and team identifiers are distinct and not interchangeable.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

The search query for name, id, externalId or parent.id

string
required

Unique identifier of the tenant (the parent scope that contains teams). Distinct from teamId — passing a teamId here will return 404 Tenant not found. Format: Revenium hashid (URL-safe encoded string).

integer
≥ 0
Defaults to 0

Zero-based page index (0..N)

integer
≥ 1
Defaults to 10

The size of the page to be returned

sort
array of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

sort
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 24 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/hal+json

Updated 24 days ago