Transactions

Get Transaction Metadata

Returns the metadata for a specific transaction. Useful for a quick lookup of a transaction by its GUID.

get/transactions/{transactionId}

Request

  • Base URL: https://ws.zipformplus.com/api
  • URL: https://ws.zipformplus.com/api/transactions/{transactionId}
  • Auth: API key in header X-Auth-ContextId

Response

Transaction metadata returned successfully

idstring uuid

Transaction GUID

namestring
status'active' | 'pending' | 'closed' | 'inactive' | 'locked'
expirationstring date-time
transactionType'Listing' | 'Purchase' | 'Lease' | 'LeaseListing'
propertyType'Residential' | 'Commercial' | 'Industrial' | 'VacantLand' | 'MultiUnit' | 'FarmAndRanch' | 'Condominium' | 'ManufacturedHome' | 'Coop' | 'Unlisted'
hasFilesboolean
createdstring date-time
lastUpdatedstring date-time
ownerNamestring
numberinteger
sellerstring
buyerstring
propertyAddressstring

Full address in one value

addressstring
citystring
statestring
zipstring
isSignedboolean

Whether the transaction has signed documents

EncryptedOwnerIdstring uuid

GUID of the agent who owns this transaction

Example response

{
  "name": "1060 Mountain St",
  "status": "active",
  "number": 1033771
}

Changes

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