GET/admin/v1/organizations

List organizations

Lists organizations.

query parameters

  • displayName

    string

    Filter the results by display name.

    To enable prefix filtering append * to the end of the value and ensure you provide at least 3 characters excluding the wildcard.

    This filter is case-insensitivity.

  • email

    string

    Filter the results by email address.

    To enable prefix filtering append * to the end of the value and ensure you provide at least 3 characters excluding the wildcard.

    This filter is case-insensitivity.

  • pageSize

    int32

    The maximum number of organizations to return. The API may return fewer than this value.

    If unspecified, at most 20 organizations will be returned. The maximum value is 100; values above 100 will be coerced to 100.

  • pageToken

    string

    A page token, received from a previous list organizations call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to list organizations must match the call that provided the page token.

  • orderBy

    string

    A comma-separated list of fields to order by.

    Supports:

    • displayName asc
    • email asc
    • signupTime desc
    • createTime desc
    • deleteTime desc
  • showDeleted

    boolean

    Whether to show deleted organizations.

  • view

    enum

    The organization view to return in the results.

    This defaults to the BASIC view.

    Possible values:
    BASICFULL

Returns

  • organizations

    Organization[]

    The list of organizations.

  • nextPageToken

    string

    A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

  • previousPageToken

    string

    A token, which can be sent as pageToken to retrieve the previous page. If this field is absent, there are no preceding pages. If this field is an empty string then the previous page is the first result.

curl https://api.userhub.com/admin/v1/organizations \
  -H "Authorization: Bearer $ADMIN_API_KEY"
Response bodyJSON
{
  "organizations": [
    {
      "id": "org_32P6J2tQEaYQDV",
      "state": "ACTIVE",
      "displayName": "Umbrella Corporation",
      "email": "[email protected]",
      "emailVerified": true,
      "imageUrl": "https://example.com/umbrella.jpg",
      "address": null,
      "accountConnections": [],
      "subscription": null,
      "signupTime": "2024-06-15T13:00:00Z",
      "memberCount": 0,
      "createTime": "2024-06-15T13:00:00Z",
      "updateTime": "2024-06-15T13:00:00Z"
    },
    {
      "id": "org_28seyVGVL1got6",
      "state": "ACTIVE",
      "displayName": "Acme Inc",
      "email": "[email protected]",
      "emailVerified": true,
      "imageUrl": "https://example.com/acme.jpg",
      "address": null,
      "accountConnections": [],
      "subscription": null,
      "signupTime": "2024-06-15T13:00:00Z",
      "memberCount": 0,
      "createTime": "2024-06-15T13:00:00Z",
      "updateTime": "2024-06-15T13:00:00Z"
    }
  ],
  "nextPageToken": ""
}
PreviousThe organization object
NextCreate an organization

Turn users intorevenue
$

Subscribe to monthly product updates

© 2024 UserHub

Integrations

    UserHub & Auth0UserHub & Stripe BillingUserHub & Google CloudUserHub & FirebaseUserHub & custom auth