Requests
Get a background or idempotent request
GET
The state of a request made with Prefer: respond-async or an Idempotency-Key. While status is running, response is null; when done, response holds the status and body the call would have returned. Only the API key that made the request can read it. Kept 24 hours.
Scope: any
apiKeyheader
AuthorizationBearer <ik_live_…>An organisation API key from Settings → Organisation → API keys. Each operation names the one scope it needs — see https://developer.ingenee.ai/docs/authentication.
id*stringOK
application/json- response
id*stringFormat
uuidoperation*stringstatus*stringValue in
"running""done"createdAt*stringFormat
date-timecompletedAt*|Format
date-timeresponse*|nullExample Request
curl -X GET 'https://dev.app.ingenee.ai/api/v1/requests/string'Example Response
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "operation": "generateSchedule", "status": "running", "createdAt": "2019-08-24T14:15:22Z", "completedAt": "2019-08-24T14:15:22Z", "response": { "status": 0, "body": null }}