List deals for a company

Returns deals associated with a company.

get/v1/companies/{id}/deals

Request

Base URL
https://api.metal.ai
Auth
API key in header x-metal-client-id and API key in header x-metal-api-key
TypeScript
https://skmtc.dev/metal/apis/metal-api/docs/v1/companies/:id/deals/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

The company id.

Query parameters

pageinteger

Page number, starting at 1 (max 100).

limitinteger

Items per page (1 to 1000).

Response

Deals for the company.

Example response

{
  "data": [
    {
      "id": "665f1c2a9b1e4a0012a3b4c5",
      "name": "Project Atlas",
      "status": "ACTIVE",
      "stage": "DUE_DILIGENCE",
      "acquisitionType": "platform"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.