API docs by Redocly

Workorder Portal Link API (1.0.0)

Download OpenAPI specification:Download

API for managing workorder portal links

Get all workorder portal links

Retrieve a list of all workorder portal links 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

workorder
string

Filter by workorder ID

is_active
boolean

Filter by active status

link_type
string
Enum: "public" "private" "secure"

Filter by link type

_id
Array of strings

Filter by ID

Responses

Response samples

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

Create a new workorder portal link

Create a new workorder portal link

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

Workorder ID reference

link_type
string
Default: "private"
Enum: "public" "private" "secure"

Type of portal link

object
object
expiry_date
string <date-time>

When the portal link expires

object
object
object
is_active
boolean
Default: true

Whether the portal link is active

company_namespace
Array of strings

Company namespace

Responses

Request samples

Content type
application/json
{
  • "workorder": "507f1f77bcf86cd799439012",
  • "link_type": "public",
  • "permissions": {
    },
  • "access_restrictions": {
    },
  • "expiry_date": "2019-08-24T14:15:22Z",
  • "notification_settings": {
    },
  • "custom_branding": {
    },
  • "metadata": {
    },
  • "is_active": true,
  • "company_namespace": [
    ]
}

Response samples

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

Get workorder portal link by ID

Retrieve a specific workorder portal link by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Workorder portal link ID

Responses

Response samples

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

Update workorder portal link

Update an existing workorder portal link

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Workorder portal link ID

Request Body schema: application/json
link_type
string
Enum: "public" "private" "secure"

Type of portal link

object
object
expiry_date
string <date-time>

When the portal link expires

is_active
boolean

Whether the portal link is active

object
object
object
company_namespace
Array of strings

Company namespace

Responses

Request samples

Content type
application/json
{
  • "link_type": "public",
  • "permissions": {
    },
  • "access_restrictions": {
    },
  • "expiry_date": "2019-08-24T14:15:22Z",
  • "is_active": true,
  • "notification_settings": {
    },
  • "custom_branding": {
    },
  • "metadata": {
    },
  • "company_namespace": [
    ]
}

Response samples

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

Delete workorder portal link

Delete a workorder portal link by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Workorder portal link ID

Responses

Response samples

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

Regenerate portal link

Regenerate the portal link URL and access token

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Workorder portal link ID

Responses

Response samples

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

Activate portal link

Activate a workorder portal link

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Workorder portal link ID

Responses

Response samples

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

Deactivate portal link

Deactivate a workorder portal link

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Workorder portal link ID

Responses

Response samples

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