latestOpenAPI 3.0.02026-08-216686147.9 KB

6f6009a58cdd

requests

engagements

List Requests that belong to the specified Engagement

get/v1/engagements/{uuid}/requests

Path parameters

uuidstring uuid required

The UUID of the engagement to retrieve requests for

Query parameters

statusesRequestStatus[]

Filter Requests by status. Repeat the query parameter for multiple statuses.

client_owner_user_uuidsstring[]

Filter Requests by the UUID of their Client Owner Users. Repeat the query parameter for multiple UUIDs.

due_date_beforestring date

Example:2024-05-01

Filter Requests to those with a due date before this date. Uses strict before semantics and excludes Requests with no due date.

pagenumber nullable

per_pagenumber nullable

sort_order'asc' | 'desc'

Sort order for paginated results. Use desc to reverse the default ascending order.

Response

The Requests for the Engagement

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"
        }
      }
    }
  ],
  "_links": {
    "self": {
      "href": "https://api.fieldguide.io/v1/example?page=2&per_page=50"
    },
    "first": {
      "href": "https://api.fieldguide.io/v1/example?page=1&per_page=50"
    },
    "last": {
      "href": "https://api.fieldguide.io/v1/example?page=10&per_page=50"
    },
    "previous": {
      "href": "https://api.fieldguide.io/v1/example?page=1&per_page=50"
    },
    "next": {
      "href": "https://api.fieldguide.io/v1/example?page=3&per_page=50"
    }
  }
}