Skip to main content
GET
/
v1
/
orders
/
{orderId}
/
results
JavaScript
import BlueHive from '@bluehive/sdk';

const client = new BlueHive({
  apiKey: 'My API Key',
});

const response = await client.orders.retrieveResults('orderId');

console.log(response.meta);
{
  "meta": {
    "orderId": "<string>",
    "orderNumber": "<string>",
    "employeeId": "<string>",
    "providerId": "<string>",
    "totalServices": 123,
    "page": 123,
    "pageSize": 123,
    "returned": 123
  },
  "services": [
    {
      "serviceId": "<string>",
      "status": "<string>",
      "result": "<string>",
      "altTxt": "<string>",
      "message": "<string>",
      "resultsPosted": "2023-11-07T05:31:56Z",
      "drawn_datetime": "2023-11-07T05:31:56Z",
      "completed_datetime": "2023-11-07T05:31:56Z",
      "fileIds": [
        "<string>"
      ],
      "contacts": [
        "<string>"
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

API key for accessing BlueHive API endpoints. Format: "ApiKey <your-api-key>" or "Bearer <your-api-key>"

Path Parameters

orderId
string
required

Query Parameters

serviceId
string
status
string
page
integer
default:1
Required range: x >= 1
pageSize
integer
default:50
Required range: 1 <= x <= 100
since
string<date-time>
until
string<date-time>

Response

Default Response

meta
object
required
services
object[]
required
I