...
id (required): The unique identifier of the request you want to retrieve. This should be included in the URL path. Example:
123e4567-e89b-12d3-a456-426614174000
Example cURL API call
| Code Block | ||
|---|---|---|
| ||
curl -X GET "https://test.onboarding.namirial.app/api/v2/request/YOUR_REQUEST_ID" \
-H "Accept: application/json" \
-H "X-Api-Key: YOUR_API_KEY" |
Responses
200 OK
Description: The details of the requested onboarding request.
Example Response:
Code Block language json { "id": "123e4567-e89b-12d3-a456-426614174000", "organizationId": "123e4567-e89b-12d3-a456-426614174002", "status": "RUNNING", "referenceId": "order-1234-0002", "requestTypeId": "123e4567-e89b-12d3-a456-426614174000", "parameters": { "customerName": "John Doe", "customerEmail": "john.doe@example.com" }, "createdAt": "2024-10-29T17:42:16Z", "updatedAt": "2024-10-29T17:42:16Z", "finalizedAt": null, "expireAfter": "2024-11-29T17:42:16Z" }
404 Not Found
Description: The requested resource was not found.
Example Response:
Code Block language json { "type": "about:blank", "status": 404, "title": "Not Found", "detail": "The requested resource was not found.", "instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000?ts=1729667463", "retryable": false }