Sign in
latestOpenAPI 3.0.02026-08-2217901.1 MB

ef9153fcac7c

Work Request Portals

List work request portals

Endpoint used to list work request portal resources

get/workrequestportals

Query parameters

cursorstring

Last pagination reference

limitinteger

max number of Work Request Portals returned

Headers

x-organization-idinteger

Required if using a multi organizations token

Response

Successfully fetched Work Request Portals list

nextCursorstring nullable required

The cursor to retrieve the next page of Work Request Portals.

nextPageUrlstring nullable required

Path with query parameters that can be used to retrieve the next page of Work Request Portals.

Example response

{
  "workRequestPortals": [
    {
      "id": 963,
      "title": "Shipping Portal",
      "portalUrl": "https://app.getmaintainx.com/request-portal/ae9d33c8-ef78-44c4-925d-352878db0993",
      "welcomeText": "Use this portal for all request related to our shipping activities",
      "descriptionPlaceholder": "Describe your request",
      "contactInformation": "Jimmy@example.com",
      "assetId": 852,
      "locationId": 852,
      "emailOnly": true,
      "sendEmailNotification": true
    }
  ]
}