Find current workspace

Find the API key signed-in user workspace

GET

/v1/users/me/workspace

GET

/users/me/workspace

curl -X GET "https://api.corma.io/v1/users/me/workspace" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY"

Authorization

x-corma-api-key
string
header
required
Colon-separated API key ID and secret: API_KEY_ID:API_KEY_SECRET

Response

application/json200

id
number
required
name
string | null
required
mainDomain
string | null
required
domains
string[]
required
itTeamEmail
string | null
required
financeTeamEmail
string | null
required
fallbackOwnerId
string | null
required
plan
enum<string> | null
required
One of:
freemium
startup
paid
unknown
fallbackOwner
UserEmbed | null
required
aggregates
object
required
createdAt
string<date-time>
required
The timestamp of when this resource was created. ISO 8601 format.
updatedAt
string<date-time>
required
The timestamp of the last update to this resource. ISO 8601 format.

{
  "id": 0,
  "name": "string",
  "mainDomain": "string",
  "domains": [
    "string"
  ],
  "itTeamEmail": "string",
  "financeTeamEmail": "string",
  "fallbackOwnerId": "string",
  "plan": "freemium",
  "fallbackOwner": {
    "id": "string",
    "type": "employee",
    "email": "string",
    "personalEmail": "string",
    "name": "string",
    "idpStatus": "active",
    "hrStatus": "active",
    "jobKey": "string",
    "countryCode": "string",
    "departmentKey": "string",
    "startDate": "2026-01-15T09:30:00Z",
    "terminationDate": "2026-01-15T09:30:00Z"
  },
  "aggregates": {
    "licenses": {
      "total": -9007199254740991,
      "billingStatusCounts": {
        "unrevoked": {
          "total": -9007199254740991,
          "active": -9007199254740991,
          "inactive": -9007199254740991,
          "unknown": -9007199254740991
        },
        "live": {
          "total": -9007199254740991,
          "active": -9007199254740991,
          "inactive": -9007199254740991,
          "unknown": -9007199254740991
        },
        "revoked": {
          "total": -9007199254740991,
          "active": -9007199254740991,
          "inactive": -9007199254740991,
          "unknown": -9007199254740991
        }
      },
      "activityStatusCounts": {
        "active": {
          "total": -9007199254740991,
          "unrevoked": -9007199254740991,
          "live": -9007199254740991,
          "revoked": -9007199254740991
        },
        "inactive": {
          "total": -9007199254740991,
          "unrevoked": -9007199254740991,
          "live": -9007199254740991,
          "revoked": -9007199254740991
        },
        "unknown": {
          "total": -9007199254740991,
          "unrevoked": -9007199254740991,
          "live": -9007199254740991,
          "revoked": -9007199254740991
        }
      }
    }
  },
  "createdAt": "2026-01-15T09:30:00Z",
  "updatedAt": "2026-01-15T09:30:00Z"
}

GET

/users/me/workspace

curl -X GET "https://api.corma.io/v1/users/me/workspace" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY"

{
  "id": 0,
  "name": "string",
  "mainDomain": "string",
  "domains": [
    "string"
  ],
  "itTeamEmail": "string",
  "financeTeamEmail": "string",
  "fallbackOwnerId": "string",
  "plan": "freemium",
  "fallbackOwner": {
    "id": "string",
    "type": "employee",
    "email": "string",
    "personalEmail": "string",
    "name": "string",
    "idpStatus": "active",
    "hrStatus": "active",
    "jobKey": "string",
    "countryCode": "string",
    "departmentKey": "string",
    "startDate": "2026-01-15T09:30:00Z",
    "terminationDate": "2026-01-15T09:30:00Z"
  },
  "aggregates": {
    "licenses": {
      "total": -9007199254740991,
      "billingStatusCounts": {
        "unrevoked": {
          "total": -9007199254740991,
          "active": -9007199254740991,
          "inactive": -9007199254740991,
          "unknown": -9007199254740991
        },
        "live": {
          "total": -9007199254740991,
          "active": -9007199254740991,
          "inactive": -9007199254740991,
          "unknown": -9007199254740991
        },
        "revoked": {
          "total": -9007199254740991,
          "active": -9007199254740991,
          "inactive": -9007199254740991,
          "unknown": -9007199254740991
        }
      },
      "activityStatusCounts": {
        "active": {
          "total": -9007199254740991,
          "unrevoked": -9007199254740991,
          "live": -9007199254740991,
          "revoked": -9007199254740991
        },
        "inactive": {
          "total": -9007199254740991,
          "unrevoked": -9007199254740991,
          "live": -9007199254740991,
          "revoked": -9007199254740991
        },
        "unknown": {
          "total": -9007199254740991,
          "unrevoked": -9007199254740991,
          "live": -9007199254740991,
          "revoked": -9007199254740991
        }
      }
    }
  },
  "createdAt": "2026-01-15T09:30:00Z",
  "updatedAt": "2026-01-15T09:30:00Z"
}

- GETFind current workspace

Find current workspace - Corma Help Center | Productlane

API referenceWorkspaces

Find current workspace

Find the API key signed-in user workspace

GET

/v1/users/me/workspace

GET

/users/me/workspace

curl -X GET "https://api.corma.io/v1/users/me/workspace" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY"

Authorization

x-corma-api-key
string
header
required
Colon-separated API key ID and secret: API_KEY_ID:API_KEY_SECRET

Response

application/json200

id
number
required
name
string | null
required
mainDomain
string | null
required
domains
string[]
required
itTeamEmail
string | null
required
financeTeamEmail
string | null
required
fallbackOwnerId
string | null
required
plan
enum<string> | null
required
One of:
freemium
startup
paid
unknown
fallbackOwner
UserEmbed | null
required
aggregates
object
required
createdAt
string<date-time>
required
The timestamp of when this resource was created. ISO 8601 format.
updatedAt
string<date-time>
required
The timestamp of the last update to this resource. ISO 8601 format.

{
  "id": 0,
  "name": "string",
  "mainDomain": "string",
  "domains": [
    "string"
  ],
  "itTeamEmail": "string",
  "financeTeamEmail": "string",
  "fallbackOwnerId": "string",
  "plan": "freemium",
  "fallbackOwner": {
    "id": "string",
    "type": "employee",
    "email": "string",
    "personalEmail": "string",
    "name": "string",
    "idpStatus": "active",
    "hrStatus": "active",
    "jobKey": "string",
    "countryCode": "string",
    "departmentKey": "string",
    "startDate": "2026-01-15T09:30:00Z",
    "terminationDate": "2026-01-15T09:30:00Z"
  },
  "aggregates": {
    "licenses": {
      "total": -9007199254740991,
      "billingStatusCounts": {
        "unrevoked": {
          "total": -9007199254740991,
          "active": -9007199254740991,
          "inactive": -9007199254740991,
          "unknown": -9007199254740991
        },
        "live": {
          "total": -9007199254740991,
          "active": -9007199254740991,
          "inactive": -9007199254740991,
          "unknown": -9007199254740991
        },
        "revoked": {
          "total": -9007199254740991,
          "active": -9007199254740991,
          "inactive": -9007199254740991,
          "unknown": -9007199254740991
        }
      },
      "activityStatusCounts": {
        "active": {
          "total": -9007199254740991,
          "unrevoked": -9007199254740991,
          "live": -9007199254740991,
          "revoked": -9007199254740991
        },
        "inactive": {
          "total": -9007199254740991,
          "unrevoked": -9007199254740991,
          "live": -9007199254740991,
          "revoked": -9007199254740991
        },
        "unknown": {
          "total": -9007199254740991,
          "unrevoked": -9007199254740991,
          "live": -9007199254740991,
          "revoked": -9007199254740991
        }
      }
    }
  },
  "createdAt": "2026-01-15T09:30:00Z",
  "updatedAt": "2026-01-15T09:30:00Z"
}

GET

/users/me/workspace

curl -X GET "https://api.corma.io/v1/users/me/workspace" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY"

{
  "id": 0,
  "name": "string",
  "mainDomain": "string",
  "domains": [
    "string"
  ],
  "itTeamEmail": "string",
  "financeTeamEmail": "string",
  "fallbackOwnerId": "string",
  "plan": "freemium",
  "fallbackOwner": {
    "id": "string",
    "type": "employee",
    "email": "string",
    "personalEmail": "string",
    "name": "string",
    "idpStatus": "active",
    "hrStatus": "active",
    "jobKey": "string",
    "countryCode": "string",
    "departmentKey": "string",
    "startDate": "2026-01-15T09:30:00Z",
    "terminationDate": "2026-01-15T09:30:00Z"
  },
  "aggregates": {
    "licenses": {
      "total": -9007199254740991,
      "billingStatusCounts": {
        "unrevoked": {
          "total": -9007199254740991,
          "active": -9007199254740991,
          "inactive": -9007199254740991,
          "unknown": -9007199254740991
        },
        "live": {
          "total": -9007199254740991,
          "active": -9007199254740991,
          "inactive": -9007199254740991,
          "unknown": -9007199254740991
        },
        "revoked": {
          "total": -9007199254740991,
          "active": -9007199254740991,
          "inactive": -9007199254740991,
          "unknown": -9007199254740991
        }
      },
      "activityStatusCounts": {
        "active": {
          "total": -9007199254740991,
          "unrevoked": -9007199254740991,
          "live": -9007199254740991,
          "revoked": -9007199254740991
        },
        "inactive": {
          "total": -9007199254740991,
          "unrevoked": -9007199254740991,
          "live": -9007199254740991,
          "revoked": -9007199254740991
        },
        "unknown": {
          "total": -9007199254740991,
          "unrevoked": -9007199254740991,
          "live": -9007199254740991,
          "revoked": -9007199254740991
        }
      }
    }
  },
  "createdAt": "2026-01-15T09:30:00Z",
  "updatedAt": "2026-01-15T09:30:00Z"
}