Get the status of a previously issued data request

GET /requests/{requestId}
O auth

Retrieve a specific data request, which is currently in progress.

Path parameters

  • requestId string Required

    A random identifier that uniquely identifies a request. A version 4 UUID is strongly recommended. Note: the generated identifier must be random. The identifier must not include any information that can be related to the requester. Additionally, requestIds must not be incremental.

Responses

  • 200

    OK

    Hide response attributes Show response attributes object
    • requestId string(uuid) Required

      A random identifier that uniquely identifies a request. A version 4 UUID is strongly recommended. Note: the generated identifier must be random. The identifier must not include any information that can be related to the requester. Additionally, requestIds must not be incremental.

    • createdAt string(date-time) Required

      A date-time detailing when the request was made

    • expectedCompletion string(date-time)

      An optional date-time detailing when the request is expected to be completed

    • isCompleted boolean Required

      Whether the request has been completed already

    • completedAt string(date-time)

      An optional date-time detailing when the request was completed.

    • dataRequested array[string] Required

      Identifier of a data type that was requested
  • 401

    Unauthorized

    Hide response attributes Show response attributes object
    • error string

      Value is Unauthorized.

    • message string

      Value is You are not authorized. Generate authentication tokens via OAuth to access this resource..
  • 404

    Not Found

    Hide response attributes Show response attributes object
    • error string

      Value is Not Found.

    • message string

      Value is Could not find a data request with this id..
GET /requests/{requestId} 
curl \
 -X GET http://api.example.com/requests/{requestId} \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "requestId": "string",
  "createdAt": "2023-05-04T09:42:00+00:00",
  "expectedCompletion": "2023-05-04T09:42:00+00:00",
  "isCompleted": true,
  "completedAt": "2023-05-04T09:42:00+00:00",
  "dataRequested": [
    "string"
  ]
}
Response examples (200) 
{
  "requestId": "string",
  "createdAt": "2025-05-04T09:42:00Z",
  "expectedCompletion": "2025-05-04T09:42:00Z",
  "isCompleted": true,
  "completedAt": "2025-05-04T09:42:00Z",
  "dataRequested": [
    "string"
  ]
}
Response examples (401) 
{
  "error": "Unauthorized",
  "message": "You are not authorized. Generate authentication tokens via OAuth to access this resource."
}
Response examples (401) 
{
  "error": "Unauthorized",
  "message": "You are not authorized. Generate authentication tokens via OAuth to access this resource."
}
Response examples (404) 
{
  "error": "Not Found",
  "message": "Could not find a data request with this id."
}
Response examples (404) 
{
  "error": "Not Found",
  "message": "Could not find a data request with this id."
}