Sign in
Enterprise Management

List enterprises for an organization

List all enterprises in the specified organization for the authenticated user.

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

Path parameters

organizationIdstring required
Example:59cd72485007a239fb00282ed480da1f

Query parameters

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.

qstring
Example:abc@email.com

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

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 1 of the 16 revisions of this API.215

  • ee916dca3250215See the full diff
    • ▲

      the response property enterprises/items/oneOf[subschema #1: Enterprise]/allOf[subschema #2: Base Enterprise]/businessModel became nullable for the status 200

      response-property-became-nullable

    • ▲

      the enterprises/items/oneOf[subschema #1: Enterprise]/allOf[subschema #2: Base Enterprise]/businessModel response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • ●

      added the new Go Network - Off Exchange Settlement - OKX enum value to the enterprises/items/oneOf[subschema #1: Enterprise]/allOf[subschema #2: Base Enterprise]/requestedBitgoProducts/items/ response property for the response status 200

      response-property-enum-value-added

    • ○

      added the optional property enterprises/items/oneOf[subschema #1: Enterprise]/allOf[subschema #2: Base Enterprise]/otcServicesAgreement to the response with the 200 status

      response-optional-property-added

    • ○

      added BusinessModel to the enterprises/items/oneOf[subschema #1: Enterprise]/allOf[subschema #2: Base Enterprise]/businessModel response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      removed the bitgoAsAService enum value from the enterprises/items/oneOf[subschema #1: Enterprise]/allOf[subschema #2: Base Enterprise]/businessModel response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the cryptoAsAServiceChild enum value from the enterprises/items/oneOf[subschema #1: Enterprise]/allOf[subschema #2: Base Enterprise]/businessModel response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the cryptoAsAServiceParent enum value from the enterprises/items/oneOf[subschema #1: Enterprise]/allOf[subschema #2: Base Enterprise]/businessModel response property for the response status 200

      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