Sign in
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
    }
  ]
}

Changes

Changed in 2 of the 33 revisions of this API.225

  • 4e2cf56dec091See the full diff
    • ●

      added the new Kyt enum value to the ///// response property for the response status

      response-property-enum-value-added

  • ee916dca3250215See the full diff
    • ▲

      the response property //// became nullable for the status

      response-property-became-nullable

    • ▲

      the //// response's property type changed from string to no type for status

      response-property-type-changed

    • ●

      added the new Go Network - Off Exchange Settlement - OKX enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

    • ○

      added to the //// response property allOf list for the response status

      response-property-all-of-added

    • ○

      removed the bitgoAsAService enum value from the //// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the cryptoAsAServiceChild enum value from the //// response property for the response status

      response-property-enum-value-removed

    • ○

      removed the cryptoAsAServiceParent enum value from the //// response property for the response status

      response-property-enum-value-removed

    This revision also has 17 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog