Documentation Index
Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
Use this file to discover all available pages before exploring further.
Server path: /repairshopr-admin | Type: Application | PCID required: Yes
repairshopr_admin_create_customers_by_customer_id_phones
Creates a Phone
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
customer_id | integer | Yes | — | Customer Id |
extension | string | No | — | The extension value |
label | string | No | — | The label value |
number | string | No | — | The number value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customer_id": {
"type": "integer",
"description": "Customer Id"
},
"extension": {
"type": "string",
"description": "The extension value"
},
"label": {
"type": "string",
"description": "The label value"
},
"number": {
"type": "string",
"description": "The number value"
}
},
"required": [
"PCID",
"customer_id"
]
}
repairshopr_admin_create_otp_login
Authorize a User with One Time Password
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
code | string | No | — | The code value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"code": {
"type": "string",
"description": "The code value"
}
},
"required": [
"PCID"
]
}
repairshopr_admin_create_rmm_alerts
Creates an RMM Alert
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
asset_id | integer | No | — | Asset Id |
customer_id | integer | No | — | Customer Id |
description | string | No | — | The description value |
properties | object | No | — | The properties value |
resolved | boolean | No | — | The resolved value |
status | string | No | — | The status value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"asset_id": {
"type": "integer",
"description": "Asset Id"
},
"customer_id": {
"type": "integer",
"description": "Customer Id"
},
"description": {
"type": "string",
"description": "The description value"
},
"properties": {
"type": "object",
"description": "The properties value",
"properties": {
"subject": {
"type": "string",
"description": "The subject value"
},
"body": {
"type": "string",
"description": "The body value"
},
"hidden": {
"type": "boolean",
"description": "The hidden value"
},
"sms_body": {
"type": "string",
"description": "Sms Body"
},
"do_not_email": {
"type": "boolean",
"description": "Do Not Email"
},
"tech": {
"type": "string",
"description": "The tech value"
}
}
},
"resolved": {
"type": "boolean",
"description": "The resolved value"
},
"status": {
"type": "string",
"description": "The status value"
}
},
"required": [
"PCID"
]
}
repairshopr_admin_create_rmm_alerts_by_id_mute
Mutes an RMM Alert by ID
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | The id value |
mute_for | string | Yes | — | Length of time to mute alert for. Accepted values: ‘1-hour’, ‘1-day’, ‘2-days’, ‘1-week’, ‘2-weeks’, ‘1-month’, ‘forever’ |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The id value"
},
"mute_for": {
"type": "string",
"description": "Length of time to mute alert for. Accepted values: '1-hour', '1-day', '2-days', '1-week', '2-weeks', '1-month', 'forever'"
}
},
"required": [
"PCID",
"id",
"mute_for"
]
}
repairshopr_admin_create_tickets_by_ticket_id_worksheet_results
Creates Worksheet Result
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
ticket_id | integer | Yes | — | Ticket Id |
title | string | No | — | The title value |
worksheet_template_id | integer | No | — | Worksheet Template Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ticket_id": {
"type": "integer",
"description": "Ticket Id"
},
"title": {
"type": "string",
"description": "The title value"
},
"worksheet_template_id": {
"type": "integer",
"description": "Worksheet Template Id"
}
},
"required": [
"PCID",
"ticket_id"
]
}
repairshopr_admin_create_user_devices
Creates a User Device
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
device_name | string | No | — | Device Name |
device_uuid | string | No | — | Device Uuid |
model | string | No | — | The model value |
registration_token_gcm | string | No | — | Registration Token Gcm |
screen_size | string | No | — | Screen Size |
system_name | string | No | — | System Name |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"device_name": {
"type": "string",
"description": "Device Name"
},
"device_uuid": {
"type": "string",
"description": "Device Uuid"
},
"model": {
"type": "string",
"description": "The model value"
},
"registration_token_gcm": {
"type": "string",
"description": "Registration Token Gcm"
},
"screen_size": {
"type": "string",
"description": "Screen Size"
},
"system_name": {
"type": "string",
"description": "System Name"
}
},
"required": [
"PCID"
]
}
repairshopr_admin_create_wiki_pages
Creates a Wiki Page
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
asset_id | integer | No | — | Asset Id |
body | string | No | — | The body value |
customer_id | integer | No | — | Customer Id |
name | string | No | — | The name value |
slug | string | No | — | The slug value |
visibility | string | No | — | The visibility value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"asset_id": {
"type": "integer",
"description": "Asset Id"
},
"body": {
"type": "string",
"description": "The body value"
},
"customer_id": {
"type": "integer",
"description": "Customer Id"
},
"name": {
"type": "string",
"description": "The name value"
},
"slug": {
"type": "string",
"description": "The slug value"
},
"visibility": {
"type": "string",
"description": "The visibility value"
}
},
"required": [
"PCID"
]
}
repairshopr_admin_delete_customers_by_customer_id_phones_by_id
Deletes a Phone by ID
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
customer_id | integer | Yes | — | Customer Id |
id | integer | Yes | — | The id value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customer_id": {
"type": "integer",
"description": "Customer Id"
},
"id": {
"type": "integer",
"description": "The id value"
}
},
"required": [
"PCID",
"customer_id",
"id"
]
}
repairshopr_admin_delete_rmm_alerts_by_id
Deletes/Clears an RMM Alert by ID
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | The id value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The id value"
}
},
"required": [
"PCID",
"id"
]
}
repairshopr_admin_delete_tickets_by_ticket_id_worksheet_results_by_id
Deletes a Worksheet Result
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
ticket_id | integer | Yes | — | Ticket Id |
id | integer | Yes | — | The id value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ticket_id": {
"type": "integer",
"description": "Ticket Id"
},
"id": {
"type": "integer",
"description": "The id value"
}
},
"required": [
"PCID",
"ticket_id",
"id"
]
}
repairshopr_admin_delete_wiki_pages_by_id
Deletes a Wiki Page by ID
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | The id value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The id value"
}
},
"required": [
"PCID",
"id"
]
}
repairshopr_admin_get_customers_by_customer_id_phones
Returns a paginated list of Phones
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
customer_id | integer | Yes | — | Customer Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customer_id": {
"type": "integer",
"description": "Customer Id"
}
},
"required": [
"PCID",
"customer_id"
]
}
repairshopr_admin_get_rmm_alerts_by_id
Retrieves an RMM Alert by ID
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | The id value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The id value"
}
},
"required": [
"PCID",
"id"
]
}
repairshopr_admin_get_tickets_by_ticket_id_worksheet_results
Returns a paginated list of Worksheet Results
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
ticket_id | integer | Yes | — | Ticket Id |
page | integer | No | — | Returns provided page of results, each ‘page’ contains 25 results |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ticket_id": {
"type": "integer",
"description": "Ticket Id"
},
"page": {
"type": "integer",
"description": "Returns provided page of results, each 'page' contains 25 results"
}
},
"required": [
"PCID",
"ticket_id"
]
}
repairshopr_admin_get_tickets_by_ticket_id_worksheet_results_by_id
Retrieves a Worksheet Result by ID
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
ticket_id | integer | Yes | — | Ticket Id |
id | integer | Yes | — | The id value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ticket_id": {
"type": "integer",
"description": "Ticket Id"
},
"id": {
"type": "integer",
"description": "The id value"
}
},
"required": [
"PCID",
"ticket_id",
"id"
]
}
repairshopr_admin_get_user_devices_by_id
Retrieves an existing User Device by UUID
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | User Device UUID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "User Device UUID"
}
},
"required": [
"PCID",
"id"
]
}
repairshopr_admin_get_users_by_id
Retrieves an existing User by ID
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | The id value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The id value"
}
},
"required": [
"PCID",
"id"
]
}
repairshopr_admin_get_wiki_pages_by_id
Retrieves a Wiki Page
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | The id value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The id value"
}
},
"required": [
"PCID",
"id"
]
}
repairshopr_admin_list_callerid
Get Caller ID
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
did | string | Yes | — | Phone number |
outbound | boolean | No | — | The outbound value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"did": {
"type": "string",
"description": "Phone number"
},
"outbound": {
"type": "boolean",
"description": "The outbound value"
}
},
"required": [
"PCID",
"did"
]
}
repairshopr_admin_list_me
Returns the current user
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
repairshopr_admin_list_rmm_alerts
Returns a paginated list of RMM Alerts
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
status | string | No | — | Possible values resolved, all, active. |
page | integer | No | — | Returns provided page of results, each ‘page’ contains 25 results |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"status": {
"type": "string",
"description": "Possible values resolved, all, active."
},
"page": {
"type": "integer",
"description": "Returns provided page of results, each 'page' contains 25 results"
}
},
"required": [
"PCID"
]
}
repairshopr_admin_list_settings
Returns a list of Account Settings
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
repairshopr_admin_list_settings_printing
Returns Printing Settings
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
repairshopr_admin_list_settings_tabs
Returns Tabs Settings
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
repairshopr_admin_list_users
Returns a paginated list of Users
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
repairshopr_admin_list_wiki_pages
Returns a paginated list of Wiki Pages
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
page | integer | No | — | Returns provided page of results, each ‘page’ contains 100 result |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Returns provided page of results, each 'page' contains 100 result"
}
},
"required": [
"PCID"
]
}
repairshopr_admin_update_customers_by_customer_id_phones_by_id
Updates an existing Phone by ID
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
customer_id | integer | Yes | — | Customer Id |
id | integer | Yes | — | The id value |
extension | string | No | — | The extension value |
label | string | No | — | The label value |
number | string | No | — | The number value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"customer_id": {
"type": "integer",
"description": "Customer Id"
},
"id": {
"type": "integer",
"description": "The id value"
},
"extension": {
"type": "string",
"description": "The extension value"
},
"label": {
"type": "string",
"description": "The label value"
},
"number": {
"type": "string",
"description": "The number value"
}
},
"required": [
"PCID",
"customer_id",
"id"
]
}
repairshopr_admin_update_tickets_by_ticket_id_worksheet_results_by_id
Updates a Worksheet Result
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
ticket_id | integer | Yes | — | Ticket Id |
id | integer | Yes | — | The id value |
answers | object | No | — | The answers value |
complete | boolean | No | — | The complete value |
public | boolean | No | — | The public value |
required | boolean | No | — | The required value |
title | string | No | — | The title value |
user_id | integer | No | — | User Id |
worksheet_template_id | integer | No | — | Worksheet Template Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ticket_id": {
"type": "integer",
"description": "Ticket Id"
},
"id": {
"type": "integer",
"description": "The id value"
},
"answers": {
"type": "object",
"description": "The answers value",
"properties": {
"value": {
"type": "string",
"description": "The value value"
},
"user": {
"type": "string",
"description": "The user value"
}
}
},
"complete": {
"type": "boolean",
"description": "The complete value"
},
"public": {
"type": "boolean",
"description": "The public value"
},
"required": {
"type": "boolean",
"description": "The required value"
},
"title": {
"type": "string",
"description": "The title value"
},
"user_id": {
"type": "integer",
"description": "User Id"
},
"worksheet_template_id": {
"type": "integer",
"description": "Worksheet Template Id"
}
},
"required": [
"PCID",
"ticket_id",
"id"
]
}
repairshopr_admin_update_user_devices_by_id
Updates an existing User Device by UUID
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | Device UUID |
registration_token_gcm | string | No | — | Registration Token Gcm |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Device UUID"
},
"registration_token_gcm": {
"type": "string",
"description": "Registration Token Gcm"
}
},
"required": [
"PCID",
"id"
]
}
repairshopr_admin_update_wiki_pages_by_id
Updates an existing Wiki Page by ID
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | The id value |
asset_id | integer | No | — | Asset Id |
body | string | No | — | The body value |
customer_id | integer | No | — | Customer Id |
name | string | No | — | The name value |
slug | string | No | — | The slug value |
visibility | string | No | — | The visibility value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "The id value"
},
"asset_id": {
"type": "integer",
"description": "Asset Id"
},
"body": {
"type": "string",
"description": "The body value"
},
"customer_id": {
"type": "integer",
"description": "Customer Id"
},
"name": {
"type": "string",
"description": "The name value"
},
"slug": {
"type": "string",
"description": "The slug value"
},
"visibility": {
"type": "string",
"description": "The visibility value"
}
},
"required": [
"PCID",
"id"
]
}