Developers
V1PlatformCorporates

Search corporate workspaces, 25 per page

GET
/v1/platform/corporates
AuthorizationBearer <token>

In: header

Query Parameters

q?string
Lengthlength <= 100
Default""
stage?string

Value in

  • "prospect"
  • "invited"
  • "active"
  • "suspended"
page?integer
Range1 <= value <= 400
Default1

Response Body

application/json

curl -X GET "https://example.com/v1/platform/corporates"
{  "corporates": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "contactName": "string",      "email": "string",      "version": -9007199254740991,      "stage": "prospect",      "createdAt": "2019-08-24T14:15:22Z",      "members": 0    }  ],  "total": 0,  "page": -9007199254740991,  "pageSize": 25}

Operational totals across corporate workspaces (platform admin only) GET

Malaysia calendar dates, at most 366 days; the window preserves selected dates and daily rows omit future dates. Current membership, invitation and stock counts use report time, independent of the selected period. Period counts use membership join/end timestamps, invitation creation/acceptance timestamps, and claims reserved in the period. Invitation and claim cohort outcomes are mutually exclusive as of report time, not period end. Daily claim outcomes are grouped by claim reservation date. Membership history is the latest stored membership edge, not a complete rejoin ledger; deleted and pending-deletion accounts are excluded. No employee identities, health values, health participation, app activity, or individual sharing status are returned. MC operational totals are available only to the current corporate workspace owner or HR admin through the partner endpoint. They include requests explicitly submitted with valid sharing consent, exclude drafts and departed/deleted employees, and count submitted, approved, rejected and withdrawn requests. Calendar-day totals count inclusive overlap with the full selected dates, including future dates; they do not establish entitlement or predict absence. Platform endpoints never include MC totals. Corporate totals include workspaces in every lifecycle state; the current workspace counts break out active, pending and suspended. Member counts count membership edges across companies, not distinct people. No per-company ranking is returned.

Create a corporate prospect; reuse the same id when retrying POST

Next Page