API Reference
Log In
API Reference

List Organizations

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

Retrieve a paginated list of the customer organizations in your account. Note on scope: customer organizations (your own customers) belong to your account, and each team in the account can reference them. For this reason, this endpoint takes your account ID (tenantId), not the team ID used by team-scoped endpoints (jobs, subscriptions, products, etc.). Account IDs and team IDs are not interchangeable: passing a team ID returns 404.

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

The ID of your Revenium account (not a team ID). It is the tenantId returned by GET /v2/api/users/me.

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 5 months ago

Did this page help you?
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 5 months ago

Did this page help you?