Get preview formatted offer number for new document

Generates a preview formatted offer number that will be assigned when the document is created. This is used for UI display purposes only. Requires snapshotId to format with correct version.

GET/projects/{projectId}/documents/preview-offer-number/{snapshotId}

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:read

AuthorizationBearer token (JWT) · headerrequired

Path parameters

projectIdstringrequired

Project ID

snapshotIdstringrequired

Snapshot ID for version information

Responses

200

Preview formatted offer number

formattedOfferNumberstring

401

Unauthorized - Invalid or missing authentication token

403

Forbidden - Insufficient API scopes or permissions

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

OAuth2 access tokenRemember on this deviceInclude my values in samples

Parameters

projectIdpath*Project IDsnapshotIdpath*Snapshot ID for version information

Request

curl -X GET "https://leadtime.app/api/public/projects/string/documents/preview-offer-number/string" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

const response = await fetch("https://leadtime.app/api/public/projects/string/documents/preview-offer-number/string", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
  }
});

import requests

response = requests.get(
    "https://leadtime.app/api/public/projects/string/documents/preview-offer-number/string",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN"
    },
)

Response

{
  "formattedOfferNumber": "WKM-1-v2-27012026-1"
}