API docs by Redocly

Workorder Portal API (1.0.0)

Download OpenAPI specification:Download

API for managing workorder portal operations

Workorder Portal

Workorder portal management operations

Get workorder portal entries

Retrieve workorder portal entries with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
page
integer >= 1
Default: 1

Page number for pagination

per_page
integer [ 1 .. 100 ]
Default: 25

Number of items per page

sort
string

Sort field

company_namespace
Array of strings

Company namespace for filtering

status
string
Enum: "pending" "in_progress" "completed" "cancelled"

Filter by status

workorder
string

Filter by workorder ID

client
string

Filter by client ID

_id
Array of strings

Filter by ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "paging": {
    }
}

Create a new workorder portal entry

Create a new workorder portal entry

Authorizations:
ApiKeyAuth
Request Body schema: application/json
workorder
required
string

Workorder ID reference

client
required
string

Client ID reference

access_level
string
Default: "view_only"
Enum: "view_only" "comment" "full_access"

Level of access granted

allowed_actions
Array of strings
Default: ["view"]
Items Enum: "view" "comment" "upload_files" "approve" "reject"

Actions allowed for this portal access

expiry_date
string <date-time>

When portal access expires

object
object
object
company_namespace
Array of strings

Company namespace

disabled
boolean
Default: false

Whether portal access is disabled

Responses

Request samples

Content type
application/json
{
  • "workorder": "507f1f77bcf86cd799439012",
  • "client": "507f1f77bcf86cd799439013",
  • "access_level": "view_only",
  • "allowed_actions": [
    ],
  • "expiry_date": "2019-08-24T14:15:22Z",
  • "notifications": {
    },
  • "portal_settings": {
    },
  • "custom_branding": {
    },
  • "company_namespace": [
    ],
  • "disabled": false
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get workorder portal entry by ID

Retrieve a specific workorder portal entry by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Workorder portal entry ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update workorder portal entry

Update an existing workorder portal entry

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Workorder portal entry ID

Request Body schema: application/json
status
string
Enum: "pending" "in_progress" "completed" "cancelled"

Current status

access_level
string
Enum: "view_only" "comment" "full_access"

Level of access granted

allowed_actions
Array of strings
Items Enum: "view" "comment" "upload_files" "approve" "reject"
expiry_date
string <date-time>

When portal access expires

object
object
object
company_namespace
Array of strings

Company namespace

disabled
boolean

Whether portal access is disabled

Responses

Request samples

Content type
application/json
{
  • "status": "pending",
  • "access_level": "view_only",
  • "allowed_actions": [
    ],
  • "expiry_date": "2019-08-24T14:15:22Z",
  • "notifications": {
    },
  • "portal_settings": {
    },
  • "custom_branding": {
    },
  • "company_namespace": [
    ],
  • "disabled": true
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete workorder portal entry

Delete a workorder portal entry by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Workorder portal entry ID

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Update workorder portal status

Update the status of a workorder portal entry

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Workorder portal entry ID

Request Body schema: application/json
status
required
string
Enum: "pending" "in_progress" "completed" "cancelled"

New status

notes
string

Status update notes

Responses

Request samples

Content type
application/json
{
  • "status": "pending",
  • "notes": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}