Transact API

1.0.0

Transact API

For AI assistants and coding agents: a machine-readable OpenAPI 3.0.3 definition of this API is available at the .json download link on this page (or directly at https://bump.sh/<org>/doc/transact/download). Prefer the raw specification over scraping this rendered page.

The Transact API provides programmatic access to Lone Wolf's transaction management platform. It covers the full transaction lifecycle: creating and updating transactions, managing offers, contacts, folders and documents, sharing transactions across teams via share groups, attaching forms from form libraries, and sending documents out for e-signature through Authentisign.

Index

1. Quickstart
2. Authentication
3. Conventions
4. Universal Global Fields
5. Services

Quickstart

Get from zero to a first successful call in two requests.

1. Get an access token

curl -X POST https://gateway.lwolf.com/oauth/token \
  -H "Content-Type: application/json" \
  -d '{
    "grant_type": "client_credentials",
    "client_id": "<your client id>",
    "client_secret": "<your client secret>",
    "audience": "https://api.lwolf.com",
    "lwt_client_id": "<your Lone Wolf client GUID>"
  }'

Copy the access_token from the response.

2. Make an authenticated call

Every request needs both the Bearer token and the subscription key:

curl "https://gateway.lwolf.com/transact-workflow/v1/users/<userId>/transactions" \
  -H "Authorization: Bearer <access_token>" \
  -H "lw-subscription-key: <your subscription key>"

A 200 with a JSON list of transactions means you're fully set up. A 401 usually means the token is missing or expired; a 403 usually means the lw-subscription-key header is missing or invalid.

Authentication

All endpoints (except the token endpoint itself) require two credentials on every request:

Obtaining an access token

Send a POST request to https://gateway.lwolf.com/oauth/token with a JSON body:

{
    "grant_type": "client_credentials",
    "client_id": "<your client id>",
    "client_secret": "<your client secret>",
    "audience": "https://api.lwolf.com",
    "lwt_client_id": "<your Lone Wolf client GUID>"
}

The response contains an access_token to be sent as a Bearer token on subsequent calls. Tokens are short-lived; request a new token when the current one expires.

Conventions

• User scoping — most resources are addressed under /users/{userId}/…. The userId is the GUID of the user on whose behalf the operation is performed.
• OData queries — collection endpoints on the Transact Workflow service support OData query options. Use $filter to restrict results (e.g. $filter=opportunityId eq <guid>) and $expand to embed related entities (e.g. $expand=members, opportunities on share groups).
• Partial updates — PATCH endpoints accept a partial resource representation; only the fields provided are updated.
• Content type — request bodies are JSON unless noted otherwise. Document upload and signing creation use multipart/form-data.

Universal Global Fields

A consolidated reference of the transaction-related fields that can be updated through the API. These fields correspond to the request schemas of the create/update endpoints below.

1. Property fields — POST /Transactions, PATCH /users/{userId}/transactions/{transactionId}

type, address1–address4, locality, region, subRegion, postalCode, country, legalDescription, propertyIncludes, propertyExcludes, taxNumber, mlsNumber, note, schoolDistrict, zoningClass, yearBuilt, phase, propertyType, asking, deposit, taxes, closingDate, listingExpiration, listingGoesLive

2. Transaction dates & financials — POST /Offers, PATCH /users/{userId}/Offers/{offerId}

closingDate, finalWalkthroughDate, possessionDate, offerDate, expirationDate, acceptanceDate, purchasePrice, deposit

3. Contact fields — POST /Contacts, PATCH /users/{userId}/Contacts/{contactId}

contactType, slot, prefix, suffix, firstname, middlename, lastname, email, phone, cellPhone, workPhone, fax, agentId, agentLicense, companyName, officeId, officeLicense, escrowNumber, address1–address4, locality, region, postalCode, country, llcPoa

The slot field determines the ordering of contacts of the same type (1 = Buyer 1 / Seller 1, 2 = Buyer 2 / Seller 2). The full contactType enumeration (0–21, from Buyer to PestControlCompany) is documented on the Contact schemas.

Services

The API is composed of several services routed through the same gateway host:

This is version 1.0.0 of this API documentation. Last update on Jul 7, 2026.