Skip to main content
GET
/
organizations
TypeScript
import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.organizations.list({
        from: "from",
        take: 1,
        sort: "sort",
    });
}
main();
[
  {
    "id": "<string>",
    "name": "organization-1",
    "display_name": "Acme Users",
    "branding": {
      "logo_url": "<string>",
      "colors": {
        "primary": "<string>",
        "page_background": "<string>"
      }
    },
    "metadata": {},
    "token_quota": {
      "client_credentials": {
        "enforce": true,
        "per_day": 1073741824,
        "per_hour": 1073741824
      }
    }
  }
]

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
page
integer

Page index of the results to return. First page is 0.

Required range: 0 <= x <= 1000
​
per_page
integer

Number of results per page. Defaults to 50.

Required range: 1 <= x <= 100
​
include_totals
boolean

Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).

​
from
string

Optional Id from which to start selection.

​
take
integer

Number of results per page. Defaults to 50.

Required range: 1 <= x <= 100
​
sort
string

Field to sort by. Use field:order where order is 1 for ascending and -1 for descending. e.g. created_at:1. We currently support sorting by the following fields: name, display_name and created_at.

Maximum string length: 15
Pattern: ^((display_name)|(created_at)|(name))\:(1|-1)$

Response

Organizations successfully retrieved.

​
id
string<organization-id>

Organization identifier.

Maximum string length: 50
​
name
string<organization-name>
default:organization-1

The name of this organization.

Required string length: 1 - 50
​
display_name
string
default:Acme Users

Friendly name of this organization.

Required string length: 1 - 255
​
branding
object

Theme defines how to style the login pages.

​
metadata
object

Metadata associated with the organization, in the form of an object with string values (max 255 chars). Maximum of 25 metadata properties allowed.

​
token_quota
object