List Companies

Find the organization to work in: every organization your API key can act in, searchable with q=acme (any part of the name, or the exact id), with how the key reaches it. Pass its id in X-Company-Id on every call. An organization marked approvalRequired is restricted for MindCloud staff: request access in the app first. One marked staffLimited works only for the parts of MindCloud in staffApprovedApps.

GET

Headers

Optional headers

string

Optional. The id of the organization to act in. Leave it out to act in the API key's own organization. A key can also act in its child organizations, and, with "Use this key across all of your organizations" on, in every organization its creator can open in the app. List them with GET /v2/companies. Every response's X-Company-Id header names the organization it acted in. See Organizations.

Query

Arguments

string

Part of the organization name, or its id.

Search text: organizations whose name contains it, ignoring case, or whose id is exactly it. * is a wildcard.

FiltersNarrow list results with a provider-supported where expression. Learn more

string

RSQL expression used to filter list results.

PaginationRequest a specific window of rows with limit and offset. Learn more

number

Maximum number of rows to return.

number

Number of rows to skip.

SortingChoose the order of returned rows when this action supports sorting. Learn more

string

Comma-separated sort fields; prefix with - for descending.

Field selectionChoose which fields should be included in the response. Learn more

string

Comma-separated response fields to include.

Response fields

idstring

Unique id of the company.

namestring

The company's name.

descriptionstring

The company's description.

timezonestring

The company's timezone key, an abbreviation such as EDT or PST rather than an IANA zone name.

planstring

Your plan: Basic, Professional, or Enterprise.

memberCountnumber

How many people are in the company.

isPersonalboolean

True for personal workspaces rather than team companies.

isDeletedboolean

True after the company was deleted.

subscriptionIsLegacyboolean

True while the company is on a legacy plan.

subscriptionUpdatedOndate

When the subscription last changed.

createdOndate

When the company was created.

updatedOndate

When it was last changed.

accessstring

How this API key reaches the organization, and so where X-Company-Id may name it: own on every endpoint; child and staff on every endpoint that acts in other organizations except the member-only ones (API keys, audit events, child organizations, link requests, leaving a parent) and Embedded end users; member on all of those but Embedded end users; staffLimited like staff, on endpoints of the parts of MindCloud in staffApprovedApps and on endpoints shared by both parts (they accept either approval); approvalRequired on none.

ownThe API key's own organization.
childA child organization of the key's organization.
memberThe key's creator belongs to it with a role ("Use this key across all of your organizations" on).
staffThe key's creator opens it as MindCloud staff on every route ("Use this key across all of your organizations" on).
staffLimitedRestricted for MindCloud staff, and the creator is approved for only some parts of MindCloud there (staffApprovedApps): endpoints of an approved part work, endpoints shared by both parts accept either approval and so work too, and endpoints of the other part answer ORG_ACCESS_RESTRICTED.
approvalRequiredRestricted for MindCloud staff, and the creator is approved for no part of MindCloud there: request access in the app first.

staffApprovedAppsarray of string

For an organization the key reaches through MindCloud staff access (staff, staffLimited, approvalRequired): the parts of MindCloud it is open in. all when it is not restricted (or the creator may enter every restricted organization); otherwise gravity and/or cirra, the parts the creator is approved for; empty when approvalRequired. Null for every other organization.