latestOpenAPI 3.0.02026-08-216686147.9 KB

6f6009a58cdd

requests

Fetch the specified Request

get/v1/requests/{uuid}

Path parameters

uuidstring uuid required

The UUID of the Request to retrieve

Response

The Request data

Example response

{
  "data": {
    "uuid": "4d50d252-be0c-4d69-b77a-5bbdfef83f54",
    "title": "Employees hired in 2023",
    "description": "Please provide a list of employees hired this calendar year along with full HR profiles",
    "identifier": "REQ-1234",
    "client_company_uuid": "60d593b6-1c59-4f30-bf9c-56901af906a7",
    "status_label": "Waiting for Specification",
    "created_at": "2023-01-01T12:30:00.000Z",
    "due_date": "2024-05-01",
    "client_owner_user_uuids": [
      "edbf4962-20eb-499e-a7fa-eaff50c81630"
    ],
    "tags": [
      "tag-name"
    ],
    "engagement_uuids": [
      "d51b4959-a6b0-4b8a-a251-8b5f7be7765e"
    ],
    "_links": {
      "fieldguide": {
        "href": "https://example.com/resource/or/path",
        "title": "A description for the link",
        "type": "text/html"
      }
    }
  }
}