GET
/
v1
/
orders
/
{id}
curl --request GET \
  --url https://sandbox.api.24hourinspections.com/v1/orders/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "IOM-12124",
  "location": "3310 Castleton Dr, Killeen, TX, 76542",
  "current_status": "Verifying Scope",
  "asset_type_id": "59e2d99d-8e48-4845-acee-c0a81af2b8ef",
  "assessment_type_id": "6bed093f-62f3-4a4c-ab04-455d7ec2f27a",
  "reports": null,
  "external_id": "Loan12345",
  "notes": "Notes added while creating the order",
  "responsible_party": {
    "name": "John Doe",
    "phone": "+1-234-567-8900",
    "email": "johndoe@example.com"
  },
  "camera_holder": {
    "name": "John Doe",
    "phone": "+1-234-567-8900",
    "email": "johndoe@example.com"
  },
  "attachment": [
    {
      "type": "SCOPE_OF_WORK",
      "value": [
        {
          "description": "Plumbing- sub  !@#$%^&*()",
          "budget": 5000,
          "funded": 4000,
          "requested": 0
        }
      ],
      "content_type": "JSON"
    }
  ],
  "scope_items": {
    "items": [
      {
        "description": "Foundation-Repair settling in the floors",
        "budget": 4000,
        "funded": 0,
        "requested": 4000
      }
    ]
  },
  "webhook": {
    "url": "https://example.com/webhook",
    "trigger": "any_state_change"
  },
  "metadata": {}
}

The response includes all information associated with the order, such as its location, status, metadata, and, if applicable, scope items.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Response

200 - application/json
Get a single record
​
id
string
required

Unique identifier of the order

Example:

"IOM-12124"

​
location
string
required

Location of the order

Example:

"3310 Castleton Dr, Killeen, TX, 76542"

​
current_status
string
required

Current status of the order

Example:

"Verifying Scope"

​
asset_type_id
string
required

Asset type UUID

Example:

"59e2d99d-8e48-4845-acee-c0a81af2b8ef"

​
assessment_type_id
string
required

Assessment type UUID

Example:

"6bed093f-62f3-4a4c-ab04-455d7ec2f27a"

​
external_id
string
required

External identifier for the order

Example:

"Loan12345"

​
notes
string
required

Notes added while creating the order

Example:

"Notes added while creating the order"

​
responsible_party
object
required

Details of the responsible party

​
camera_holder
object
required

Details of the camera holder

​
attachment
object[]
required

List of attachments

​
scope_items
object
required

Details of scope items

​
reports
object

Reports related to the order

Example:

null

​
webhook
object

Webhook details for the order

​
metadata
object

External metadata related to the assessment in key-value pairs

Was this page helpful?

Get OrdersCreate an Order