Organizations

List organizations

List organizations. Returns all organizations that you are a member of. This includes the personal organization tied to your user. When you create your Hologram account, a personal organization associated solely with your account is also created. This personal org is named after you. You cannot add other users to this personal organization.

get/organizations

Request

Base URL
https://dashboard.hologram.io/api/1
Auth
HTTP basic
TypeScript
https://skmtc.dev/hologram/apis/hologram-rest-api-v1/docs/organizations/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

limitinteger

Example:25

Maximum number of results to return (max 1000)

idinteger

Filter by a specific organization ID

idsstring

Comma-separated list of organization IDs to filter by

startafterinteger

Return results after the record with this ID (cursor-based pagination)

qstring

Filter results to organizations whose name contains this string

personal_forinteger

Return only the personal organization owned by this user ID

shared_orgs_onlyinteger

When true, exclude personal organizations and return only shared organizations

useridsstring

Comma-separated list of user IDs; return only organizations that contain at least one of these users

with_verified_statusinteger

When true, include the email verification status of each member user

withbilling_schemeboolean

When true, include the billing scheme in results

Response

successboolean

Indicates whether the request was successful.

limitinteger

sizeinteger

continuesboolean

lastidinteger

ID of the last record returned, for cursor-based pagination

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.