Return Prospects Orders

Request

Retrieve a paginated list of prospect orders for the authenticated user. Returns summary information about each order including status, creation date, and basic order details.

Security

bearerToken

Query

pageinteger

Starting page number.

Default:1

Example:page=1

pageSizeinteger, <= 100

Number of records per page (default: 20, max: 100)

Default:20

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/prospects/orders?page=1&pageSize=20' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Prospect orders list retrieved successfully

Bodyapplication/json

Array [

idstring

Unique identifier of the prospect order

namestring

Name of the prospect order

descriptionstring

Detailed description of the prospect order

statusstring

Current status of the order

Enum:"pending""processing""completed""failed""expired"

userIdinteger

User ID who created the order

customerIdinteger

Customer ID associated with the order

createdAtstring, (date-time)

Timestamp when the order was created

exportedAtstring or null, (date-time)

Timestamp when the order was exported (null if not exported)

expiresAtstring, (date-time)

Timestamp when the order expires

totalAmountinteger

Total number of companies in the order

isLegacyboolean

Indicates if this is a legacy order

]

Response

[
  {
    "id": "string",
    "name": "string",
    "description": "string",
    "status": "pending",
    "userId": 0,
    "customerId": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "exportedAt": "2019-08-24T14:15:22Z",
    "expiresAt": "2019-08-24T14:15:22Z",
    "totalAmount": 0,
    "isLegacy": true
  }
]