HUhubspot
Batch

Read a batch of payments by internal ID, or unique property values

post/crm/v3/objects/payments/batch/read

Request

Query parameters

archivedboolean

Whether to return only results that have been archived.

Request body

propertiesWithHistorystring[] required
idPropertystring
propertiesstring[] required

Response

successful operation

completedAtstring date-time required
requestedAtstring date-time
startedAtstring date-time required
linksobject
status'PENDING' | 'PROCESSING' | 'CANCELED' | 'COMPLETE' required

Example response

{
  "results": [
    {
      "id": "512",
      "properties": {
        "createdate": "2019-10-30T03:30:17.883Z",
        "hs_initial_amount": "50.00",
        "hs_lastmodifieddate": "2019-12-07T16:50:06.678Z",
        "hs_latest_status": "succeeded"
      },
      "createdAt": "2019-10-30T03:30:17.883Z",
      "updatedAt": "2019-12-07T16:50:06.678Z",
      "archived": false
    }
  ]
}

Changes