Sign in
latestOpenAPI 3.0.32026-08-224982,0272.8 MB

e445c15e5bee

Enterprise Management

List enterprises for an organization

List all enterprises in the specified organization.

get/api/v2/organization/{organizationId}/enterprise

Path parameters

organizationIdstring required
Example:59cd72485007a239fb00282ed480da1f

Query parameters

idempotencyKeystring

A unique identifier used when creating the enterprise. Adding this query parameter will return the enterprise created with the given idempotency key.

limitstring number

Maximum number of results to return. If the result set is truncated, use the "nextBatchPrevId" value to get the next batch.

prevIdstring
Example:59cd72485007a239fb00282ed480da1f

Return the next batch of results, based on the "nextBatchPrevId" value from the previous batch.

searchstring
Example:abc@email.com

Filter by enterprise name or by enterprise id. Cannot be combined with idempotencyKey or prevId.

kycStatestring[]

Filter by one or more KYC states. Repeatable: ?kycState=approved&kycState=pending

accountType'individual' | 'entity'

Filter by account type (individual or entity).

businessModel'bitgoAsAService' | 'cryptoAsAServiceParent' | 'cryptoAsAServiceChild'

Filter by business model (e.g. cryptoAsAServiceChild).

Response

OK

nextBatchPrevIdstring

When a result set is truncated, this field returns the id of the last object in the previous batch. To get the next batch of results, pass this value via the 'prevId' query parameter.

Example response

{
  "enterprises": [
    {
      "organization": "59cd72485007a239fb00282ed480da1f",
      "id": "59cd72485007a239fb00282ed480da1f",
      "name": "Small Company",
      "usersViewAllWallets": true,
      "primaryContact": "59cd72485007a239fb00282ed480da1f",
      "emergencyPhone": "+11234567890",
      "approvalsRequired": 1,
      "mutablePolicyWindow": 172800,
      "totalWalletsCount": 1
    }
  ]
}