Skip to main content
GET
/
organizations
List organizations
curl --request GET \
  --url https://dashboard.hologram.io/api/1/organizations \
  --header 'Authorization: Basic <encoded-value>'
{
  "success": true,
  "limit": 123,
  "size": 123,
  "continues": true,
  "lastid": 123,
  "links": {
    "path": "<string>",
    "base": "<string>",
    "next": "<string>"
  },
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "ownerid": 123,
      "ccemails": "<string>",
      "invoice_text": "<string>",
      "preflight_timeout_in_days": 123,
      "users": [
        {
          "id": 123,
          "email": "<string>",
          "first": "<string>",
          "last": "<string>",
          "permissions": []
        }
      ],
      "pending": [
        {
          "email": "<string>",
          "inviteid": 123
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

HTTP Basic authentication using API keys. Set the username to apikey and the password to your API key. You can find your API key on the Hologram Dashboard under Account Settings.

Query Parameters

​
limit
integer

Maximum number of results to return (max 1000)

Required range: x <= 1000
Example:

25

​
id
integer

Filter by a specific organization ID

​
ids
string

Comma-separated list of organization IDs to filter by

​
startafter
integer

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

​
q
string

Filter results to organizations whose name contains this string

​
personal_for
integer

Return only the personal organization owned by this user ID

​
shared_orgs_only
integer

When true, exclude personal organizations and return only shared organizations

​
userids
string

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

​
with_verified_status
integer

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

​
withbilling_scheme
boolean

When true, include the billing scheme in results

Response

OK

​
success
boolean

Indicates whether the request was successful.

Example:

true

​
limit
integer
​
size
integer
​
continues
boolean
​
lastid
integer

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

​
links
object
​
data
object[]