Get a deal

Early access: request API access for your workspace at https://bauhow.com/support before using this endpoint.

GET/v1/deals/{id}

Authorization

AuthorizationBearer token · headerrequired

Workspace API key (`bh_…`).

Path parameters

idstringrequired

min length 1

Responses

200OK

idstringrequired

contactIdstringrequired

titlestringrequired

valuenumber | anyrequired

Show properties

Any of:

number

number

any

any

stageIdstringrequired

stageEnteredAtstring<date-time>required

statusstringrequired

Allowed:openwonlost

ownerIdstring | anyrequired

Show properties

Any of:

string

string

any

any

projectTypeIdsstring[]required

streetstring | anyrequired

Show properties

Any of:

string

string

any

any

postalCodestring | anyrequired

Show properties

Any of:

string

string

any

any

citystring | anyrequired

Show properties

Any of:

string

string

any

any

notesstring | anyrequired

Show properties

Any of:

string

string

any

any

projectIdstring | anyrequired

Show properties

Any of:

string

string

any

any

closedAtstring<date-time> | anyrequired

Show properties

Any of:

string<date-time>

string<date-time>

any

any

archivedAtstring<date-time> | anyrequired

Show properties

Any of:

string<date-time>

string<date-time>

any

any

createdAtstring<date-time>required

updatedAtstring<date-time>required

Request

curl -X GET "https://app.bauhow.com/api/v1/deals/string" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://app.bauhow.com/api/v1/deals/string", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://app.bauhow.com/api/v1/deals/string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "id": "string",
  "contactId": "string",
  "title": "string",
  "value": 0,
  "stageId": "string",
  "stageEnteredAt": "2024-01-01T00:00:00Z",
  "status": "open",
  "ownerId": "string",
  "projectTypeIds": [
    "string"
  ],
  "street": "string",
  "postalCode": "string",
  "city": "string",
  "notes": "string",
  "projectId": "string",
  "closedAt": "2024-01-01T00:00:00Z",
  "archivedAt": "2024-01-01T00:00:00Z",
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z"
}