Zum Inhalt springen
Esc
↑↓navigieren↵öffnen⌘Jvorschau

List deals (Vorgänge)

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

GET/v1/deals
Autorisierung
AuthorizationBearer-Token · headererforderlich

Workspace API key (bh_…).

Query-Parameter
limitinteger
min. 1 · max. 500 · Standard: 100
offsetinteger
min. 0 · max. 9007199254740991 · Standard: 0
contactIdstring
stageIdstring
statusstring
Erlaubt:openwonlost
includeArchivedboolean
Standard: false
updatedSincestring<date-time>
Antworten
200

OK

dataobject[]erforderlich
Eigenschaften anzeigen
Array von object
idstringerforderlich
contactIdstringerforderlich
titlestringerforderlich
valuenumber | nullerforderlich
Eigenschaften anzeigen
Mindestens eines von:
number
number
null
null
stageIdstringerforderlich
stageEnteredAtstring<date-time>erforderlich
statusstringerforderlich
Erlaubt:openwonlost
ownerIdstring | nullerforderlich
Eigenschaften anzeigen
Mindestens eines von:
string
string
null
null
projectTypeIdsstring[]erforderlich
streetstring | nullerforderlich
Eigenschaften anzeigen
Mindestens eines von:
string
string
null
null
postalCodestring | nullerforderlich
Eigenschaften anzeigen
Mindestens eines von:
string
string
null
null
citystring | nullerforderlich
Eigenschaften anzeigen
Mindestens eines von:
string
string
null
null
notesstring | nullerforderlich
Eigenschaften anzeigen
Mindestens eines von:
string
string
null
null
projectIdstring | nullerforderlich
Eigenschaften anzeigen
Mindestens eines von:
string
string
null
null
closedAtstring<date-time> | nullerforderlich
Eigenschaften anzeigen
Mindestens eines von:
string<date-time>
string<date-time>
null
null
archivedAtstring<date-time> | nullerforderlich
Eigenschaften anzeigen
Mindestens eines von:
string<date-time>
string<date-time>
null
null
createdAtstring<date-time>erforderlich
updatedAtstring<date-time>erforderlich
hasMorebooleanerforderlich
Ausprobieren
Server
Autorisierung
Parameter
Anfrage
curl -X GET 'https://app.bauhow.com/api/v1/deals' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Antwort
{
  "data": [
    {
      "id": "string",
      "contactId": "string",
      "title": "string",
      "value": 0,
      "stageId": "string",
      "stageEnteredAt": "2019-08-24T14:15:22Z",
      "status": "open",
      "ownerId": "string",
      "projectTypeIds": [
        "string"
      ],
      "street": "string",
      "postalCode": "string",
      "city": "string",
      "notes": "string",
      "projectId": "string",
      "closedAt": "2019-08-24T14:15:22Z",
      "archivedAt": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "hasMore": true
}

War diese Seite hilfreich?