Read

Pageable Endpoints

All Resource Request endpoints are pagable and follow the below structure.

Required Params

PropertyData TypeDescription
pageNumberThis is a 0-based index representing the page slice of the data you want to pull back. Each page contains 200 items.

When you get a successful response, you will be returned an object that contains the following properties possible_pages, current_page, and data.

The possible_pages property indicates the number of pages available to page through to get all of the data. The current_page property indicates the 0-based index of the page you just got the data for.

The data property is an array of objects representing the actual Resource Requests you are trying to retrieve. The data array will never be more than 200 items deep per page.

Should you specify a page query param in your request that is out of bounds with the possible_pages, you will get back an empty array in the data property.

[
  {
    "creator_id": null,
    "end_day": "6/19/20",
    "id": "012e9b89-2c7c-420b-a08a-d0e94a63e0a8",
    "start_time": "7:30 am",
    "end_time": "3:30 pm",
    "project_id": "479b6fe1-fc3e-49f3-9898-544e68bcc191",
    "start_day": "6/11/20",
    "state_id": null,
    "work_days": {
      "0": false,
      "1": true,
      "2": true,
      "3": true,
      "4": true,
      "5": false,
      "6": false
    },
    "job_title_id": "8f134c16-dee8-45f9-b622-be344d19304d",
    "category_id": "f34e8fe3-4c3b-4abb-b1f6-c1cd956ba2f5",
    "subcategory_id": "1b787e24-d67a-4042-8499-cb96b3b7ab37",
    "work_scope_text": "An example scope",
    "instruction_text": "Some items to do"
	},
  {
    "creator_id": "2116968d-7320-4edc-bda8-836968ce6622",
    "end_day": "6/26/20",
    "id": "20318bbf-bf6f-435b-9e6c-82a5891aa8ac",
    "start_time": "7:30 am",
    "end_time": "3:30 pm",
    "project_id": "479b6fe1-fc3e-49f3-9898-544e68bcc191",
    "start_day": "6/8/20",
    "state_id": null,
    "work_days": {
      "0": false,
      "1": true,
      "2": true,
      "3": true,
      "4": true,
      "5": false,
      "6": false
    },
    "job_title_id": "8f134c16-dee8-45f9-b622-be344d19304d",
    "category_id": "f34e8fe3-4c3b-4abb-b1f6-c1cd956ba2f5",
    "subcategory_id": "1b787e24-d67a-4042-8499-cb96b3b7ab37"
	}
]

Get All Resource Request in a Company

GET - /v2/companies/<company_id>/resource-requests

Note: This is a pageable endpoint

Get All Resource Request for Projects in a single Group

GET - /v2/companies/<company_id>/groups/<group_id>/resource-requests

Note: This is a pageable endpoint

Get All Resource Request for a single Project

GET - /v2/companies/<company_id>/projects/<project_id>/resource-requests

Note: This is a pageable endpoint