Bid Request

Get Bid Request

This route retrieves a bid request based on the id provided

get/v0/bid-request

Query parameters

idstring required

Unique identifier of the bid request

Example:XXXX1234

Unique identifier of the bid request

organizationIdstring

Organization to which the bid request belongs

Example:remi

Organization to which the bid request belongs

Response

Bid retrieved successfully

idstring required

Unique identifier of the bid request

urlstring uri required

URL to access the resource

Example response

{
  "id": "XXXX1234",
  "organizationId": "remi",
  "instructions": "These instructions will be sent to the quoting team. Please include any additional details that may be helpful for the quoting team to understand the request.",
  "url": "https://www.example.com/job/123",
  "files": [
    {
      "name": "completed-work-photo.jpg",
      "type": "photo",
      "url": "https://XXXXXXX.cloudfront.net/XXXXXX?Expires=1720732800&Signature=XXXXXX&Key-Pair-Id=XXXXXX"
    }
  ],
  "phase": {
    "phaseType": "pending_ntp",
    "phaseStartDate": "2024-01-01T00:00:00.000Z"
  },
  "propertyAddress": {
    "addressStreet": "123 Main St",
    "city": "Anytown",
    "stateCode": "CA",
    "zip": "12345",
    "additionalInformation": "Unit 2B",
    "gateCode": "1234",
    "isHoaApprovalRequired": true
  },
  "homeowner": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com",
    "phone": "555-123-4567",
    "phoneExtension": "123",
    "preferredLanguage": "ENGLISH",
    "preferredContactMethod": "EMAIL"
  }
}

Changes

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