> ## 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. # maintainx-organization > MaintainX Organization — manage teams, users, categories, conversations, and webhooks **Server path:** `/maintainx-organization` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ----------------------------------------------------------------------------------------------------------- | ------------------------------------ | | [`maintainx_organization_create_categories`](#maintainx_organization_create_categories) | Create new category | | [`maintainx_organization_create_customfields`](#maintainx_organization_create_customfields) | Create custom field | | [`maintainx_organization_create_subscriptions`](#maintainx_organization_create_subscriptions) | Create new subscription | | [`maintainx_organization_create_teams`](#maintainx_organization_create_teams) | Create new team | | [`maintainx_organization_create_teams_members`](#maintainx_organization_create_teams_members) | Add user to team | | [`maintainx_organization_create_users`](#maintainx_organization_create_users) | Create new user | | [`maintainx_organization_delete_categories`](#maintainx_organization_delete_categories) | Delete category | | [`maintainx_organization_delete_customfields`](#maintainx_organization_delete_customfields) | Delete custom field | | [`maintainx_organization_delete_subscriptions`](#maintainx_organization_delete_subscriptions) | Remove subscription | | [`maintainx_organization_delete_teams`](#maintainx_organization_delete_teams) | Delete team | | [`maintainx_organization_delete_teams_members`](#maintainx_organization_delete_teams_members) | Remove user from team | | [`maintainx_organization_delete_users`](#maintainx_organization_delete_users) | Remove user from organization | | [`maintainx_organization_get_categories`](#maintainx_organization_get_categories) | Get category | | [`maintainx_organization_get_conversations_members`](#maintainx_organization_get_conversations_members) | List conversation members | | [`maintainx_organization_get_customfields`](#maintainx_organization_get_customfields) | List custom fields | | [`maintainx_organization_get_subscriptions`](#maintainx_organization_get_subscriptions) | Get subscription | | [`maintainx_organization_get_subscriptions_secret`](#maintainx_organization_get_subscriptions_secret) | Get secret information | | [`maintainx_organization_get_teams`](#maintainx_organization_get_teams) | Get team | | [`maintainx_organization_get_teams_members`](#maintainx_organization_get_teams_members) | List team members | | [`maintainx_organization_get_users`](#maintainx_organization_get_users) | Get user | | [`maintainx_organization_list_categories`](#maintainx_organization_list_categories) | List categories | | [`maintainx_organization_list_conversations`](#maintainx_organization_list_conversations) | List conversations | | [`maintainx_organization_list_conversations_members`](#maintainx_organization_list_conversations_members) | List conversation members | | [`maintainx_organization_list_customfields`](#maintainx_organization_list_customfields) | List custom fields | | [`maintainx_organization_list_organizations`](#maintainx_organization_list_organizations) | List organizations | | [`maintainx_organization_list_teams`](#maintainx_organization_list_teams) | List teams | | [`maintainx_organization_list_teams_members`](#maintainx_organization_list_teams_members) | List team members | | [`maintainx_organization_list_users`](#maintainx_organization_list_users) | List users | | [`maintainx_organization_send_conversations_messages`](#maintainx_organization_send_conversations_messages) | Create new message in a conversation | | [`maintainx_organization_send_users_messages`](#maintainx_organization_send_users_messages) | Create new direct message to a user | | [`maintainx_organization_update_categories`](#maintainx_organization_update_categories) | Update category | | [`maintainx_organization_update_customfields`](#maintainx_organization_update_customfields) | Edit custom field | | [`maintainx_organization_update_subscriptions`](#maintainx_organization_update_subscriptions) | Update subscription | | [`maintainx_organization_update_teams`](#maintainx_organization_update_teams) | Update team | | [`maintainx_organization_update_teams_members`](#maintainx_organization_update_teams_members) | Update team member | | [`maintainx_organization_update_users`](#maintainx_organization_update_users) | Update user | *** ## maintainx\_organization\_create\_categories Create new category **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | `skipWebhook` | boolean | No | — | Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks | | `x-organization-id` | integer | No | — | Required if using a multi organizations token | | `description` | string | No | — | Description field for additional information. | | `label` | string | Yes | — | Label used when displaying the category. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" }, "x-organization-id": { "type": "integer", "description": "Required if using a multi organizations token" }, "description": { "type": "string", "description": "Description field for additional information." }, "label": { "type": "string", "description": "Label used when displaying the category." } }, "required": [ "PCID", "label" ] } ``` *** ## maintainx\_organization\_create\_customfields Create custom field **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | `entity` | string | Yes | — | Type of entity | | `skipWebhook` | boolean | No | — | Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks | | `x-organization-id` | integer | No | — | Required if using a multi organizations token | | `fields` | object\[] | Yes | — | The fields value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "entity": { "type": "string", "description": "Type of entity", "enum": [ "assets", "locations", "parts", "workOrders", "vendors", "purchaseOrders", "lineItemPurchaseOrders" ] }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" }, "x-organization-id": { "type": "integer", "description": "Required if using a multi organizations token" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "description": "The label value" }, "type": { "type": "string", "enum": [ "oneline", "multiline", "number", "singleSelect", "date", "datetime", "link" ], "description": "The type value" }, "options": { "type": "array", "items": { "type": "string" }, "description": "The options value" }, "includeInRecurrence": { "type": "boolean", "description": "Only relevent in the context of Work Orders" }, "required": { "type": "boolean", "description": "Mark this field as required. This only affect the frontend." }, "unlisted": { "type": "boolean", "description": "Mark this custom field as unlisted. Once unlisted it will only be editable through the Rest API. When the custom field contains data, it will be displayed in the frontend; otherwise, it will remain hidden." } }, "required": [ "label", "type" ] }, "description": "The fields value" } }, "required": [ "PCID", "entity", "fields" ] } ``` *** ## maintainx\_organization\_create\_subscriptions Create new subscription **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | `skipWebhook` | boolean | No | — | Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks | | `x-organization-id` | integer | No | — | Required if using a multi organizations token | | `body` | object | Yes | — | Subscription to create | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" }, "x-organization-id": { "type": "integer", "description": "Required if using a multi organizations token" }, "body": { "type": "object", "description": "Subscription to create" } }, "required": [ "PCID", "body" ] } ``` *** ## maintainx\_organization\_create\_teams Create new team **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ---------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | `skipWebhook` | boolean | No | — | Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks | | `x-organization-id` | integer | No | — | Required if using a multi organizations token | | `assetIds` | integer\[] | No | — | List of asset IDs that the team is responsible for | | `description` | string | No | — | The description value | | `locationIds` | integer\[] | No | — | List of location where the team is operating | | `memberIds` | integer\[] | No | — | List of user IDs that are part of the team | | `name` | string | Yes | — | The name value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" }, "x-organization-id": { "type": "integer", "description": "Required if using a multi organizations token" }, "assetIds": { "type": "array", "items": { "type": "integer" }, "description": "List of asset IDs that the team is responsible for" }, "description": { "type": "string", "description": "The description value" }, "locationIds": { "type": "array", "items": { "type": "integer" }, "description": "List of location where the team is operating" }, "memberIds": { "type": "array", "items": { "type": "integer" }, "description": "List of user IDs that are part of the team" }, "name": { "type": "string", "description": "The name value" } }, "required": [ "PCID", "name" ] } ``` *** ## maintainx\_organization\_create\_teams\_members Add user to team **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | integer | Yes | — | ID of the team | | `skipWebhook` | boolean | No | — | Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks | | `teamRole` | string | No | — | Team Role | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the team" }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" }, "teamRole": { "type": "string", "description": "Team Role", "enum": [ "ADMIN", "MEMBER" ] } }, "required": [ "PCID", "id" ] } ``` *** ## maintainx\_organization\_create\_users Create new user **Parameters:** | Parameter | Type | Required | Default | Description | | | ------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `skipWebhook` | boolean | No | — | Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks | | | `x-organization-id` | integer | No | — | Required if using a multi organizations token | | | `customRole` | string | null | No | — | Custom role name if the user has a custom role assigned | | `email` | string | null | No | — | The email value | | `externalData` | object | No | — | Extra data that can be attached to the user, for example to help reference to a matching record in an external system. | | | `extraFields` | object | No | — | Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: "Department") | | | `firstName` | string | Yes | — | First Name | | | `hourlyRate` | integer | null | No | — | Cost in cents. For example, for \$1.20, put 120. Set to `null` to set the user's rate to organization default hourly rate if defined, otherwise it would set the rate to the user's hourly rate defined in any work order. If none is defined, setting `null` will set the user's hourly rate to `null` | | `inviteType` | string | null | No | — | Invite Type | | `lastName` | string | Yes | — | Last Name | | | `phoneNumber` | string | null | No | — | Phone Number | | `role` | string | null | No | — | The role value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" }, "x-organization-id": { "type": "integer", "description": "Required if using a multi organizations token" }, "customRole": { "type": [ "string", "null" ], "description": "Custom role name if the user has a custom role assigned" }, "email": { "type": [ "string", "null" ], "description": "The email value" }, "externalData": { "description": "Extra data that can be attached to the user, for example to help reference to a matching record in an external system." }, "extraFields": { "type": "object", "description": "Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: \"Department\")" }, "firstName": { "type": "string", "description": "First Name" }, "hourlyRate": { "type": [ "integer", "null" ], "description": "Cost in cents. For example, for $1.20, put 120. Set to `null` to set the user's rate to organization default hourly rate if defined, otherwise it would set the rate to the user's hourly rate defined in any work order. If none is defined, setting `null` will set the user's hourly rate to `null`" }, "inviteType": { "type": [ "string", "null" ], "description": "Invite Type", "enum": [ "ALL", "EMAIL", "SMS", "NONE" ] }, "lastName": { "type": "string", "description": "Last Name" }, "phoneNumber": { "type": [ "string", "null" ], "description": "Phone Number" }, "role": { "type": [ "string", "null" ], "description": "The role value", "enum": [ "ADMIN", "MEMBER", "REQUESTER", "SERVICE_ACCOUNT" ] } }, "required": [ "PCID", "firstName", "lastName" ] } ``` *** ## maintainx\_organization\_delete\_categories Delete category **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | integer | Yes | — | ID of the category | | `skipWebhook` | boolean | No | — | Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the category" }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" } }, "required": [ "PCID", "id" ] } ``` *** ## maintainx\_organization\_delete\_customfields Delete custom field **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | integer | Yes | — | ID of the custom field | | `entity` | string | Yes | — | Type of entity | | `skipWebhook` | boolean | No | — | Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the custom field" }, "entity": { "type": "string", "description": "Type of entity", "enum": [ "assets", "locations", "parts", "workOrders", "vendors", "purchaseOrders", "lineItemPurchaseOrders" ] }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" } }, "required": [ "PCID", "id", "entity" ] } ``` *** ## maintainx\_organization\_delete\_subscriptions Remove subscription **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | integer | Yes | — | ID of the subscription | | `skipWebhook` | boolean | No | — | Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks | | `x-organization-id` | integer | No | — | Required if using a multi organizations token | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the subscription" }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" }, "x-organization-id": { "type": "integer", "description": "Required if using a multi organizations token" } }, "required": [ "PCID", "id" ] } ``` *** ## maintainx\_organization\_delete\_teams Delete team **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | integer | Yes | — | ID of the team | | `skipWebhook` | boolean | No | — | Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the team" }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" } }, "required": [ "PCID", "id" ] } ``` *** ## maintainx\_organization\_delete\_teams\_members Remove user from team **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | `teamId` | integer | Yes | — | ID of the team | | `userId` | integer | Yes | — | User ID of the member | | `skipWebhook` | boolean | No | — | Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "teamId": { "type": "integer", "description": "ID of the team" }, "userId": { "type": "integer", "description": "User ID of the member" }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" } }, "required": [ "PCID", "teamId", "userId" ] } ``` *** ## maintainx\_organization\_delete\_users Remove user from organization **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | integer | Yes | — | ID of the user | | `skipWebhook` | boolean | No | — | Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks | | `x-organization-id` | integer | No | — | Required if using a multi organizations token | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the user" }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" }, "x-organization-id": { "type": "integer", "description": "Required if using a multi organizations token" } }, "required": [ "PCID", "id" ] } ``` *** ## maintainx\_organization\_get\_categories Get category **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ------------------ | | `id` | integer | Yes | — | ID of the category | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the category" } }, "required": [ "PCID", "id" ] } ``` *** ## maintainx\_organization\_get\_conversations\_members List conversation members **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ------------------------------ | | `id` | integer | Yes | — | Global ID of the conversation | | `cursor` | string | No | — | Last pagination reference | | `limit` | integer | No | — | max number of Members returned | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "Global ID of the conversation" }, "cursor": { "type": "string", "description": "Last pagination reference" }, "limit": { "type": "integer", "description": "max number of Members returned" } }, "required": [ "PCID", "id" ] } ``` *** ## maintainx\_organization\_get\_customfields List custom fields **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | --------------------------------------------- | | `entity` | string | Yes | — | Type of entity | | `x-organization-id` | integer | No | — | Required if using a multi organizations token | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "entity": { "type": "string", "description": "Type of entity", "enum": [ "assets", "locations", "parts", "workOrders", "vendors", "purchaseOrders", "lineItemPurchaseOrders" ] }, "x-organization-id": { "type": "integer", "description": "Required if using a multi organizations token" } }, "required": [ "PCID", "entity" ] } ``` *** ## maintainx\_organization\_get\_subscriptions Get subscription **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ---------------------- | | `id` | integer | Yes | — | ID of the subscription | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the subscription" } }, "required": [ "PCID", "id" ] } ``` *** ## maintainx\_organization\_get\_subscriptions\_secret Get secret information **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ---------------------- | | `id` | integer | Yes | — | ID of the subscription | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the subscription" } }, "required": [ "PCID", "id" ] } ``` *** ## maintainx\_organization\_get\_teams Get team **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | -------------- | | `id` | integer | Yes | — | ID of the team | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the team" } }, "required": [ "PCID", "id" ] } ``` *** ## maintainx\_organization\_get\_teams\_members List team members **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ------------------------------ | | `cursor` | string | No | — | Last pagination reference | | `limit` | integer | No | — | max number of Members returned | | `id` | integer | Yes | — | ID of the team | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cursor": { "type": "string", "description": "Last pagination reference" }, "limit": { "type": "integer", "description": "max number of Members returned" }, "id": { "type": "integer", "description": "ID of the team" } }, "required": [ "PCID", "id" ] } ``` *** ## maintainx\_organization\_get\_users Get user **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | --------------------------------------------- | | `id` | integer | Yes | — | ID of the user | | `x-organization-id` | integer | No | — | Required if using a multi organizations token | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the user" }, "x-organization-id": { "type": "integer", "description": "Required if using a multi organizations token" } }, "required": [ "PCID", "id" ] } ``` *** ## maintainx\_organization\_list\_categories List categories **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | --------------------------------------------- | | `cursor` | string | No | — | Last pagination reference | | `limit` | integer | No | — | max number of Categories returned | | `x-organization-id` | integer | No | — | Required if using a multi organizations token | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cursor": { "type": "string", "description": "Last pagination reference" }, "limit": { "type": "integer", "description": "max number of Categories returned" }, "x-organization-id": { "type": "integer", "description": "Required if using a multi organizations token" } }, "required": [ "PCID" ] } ``` *** ## maintainx\_organization\_list\_conversations List conversations **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | --------- | -------- | ------- | -------------------------------------------------------------- | | `cursor` | string | No | — | Last pagination reference | | `limit` | integer | No | — | max number of Conversations returned | | `type` | string\[] | No | — | The type value | | `onlyNamed` | boolean | No | — | Will only show named group conversations and team conversation | | `x-organization-id` | integer | No | — | Required if using a multi organizations token | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cursor": { "type": "string", "description": "Last pagination reference" }, "limit": { "type": "integer", "description": "max number of Conversations returned" }, "type": { "type": "array", "items": { "type": "string", "enum": [ "GROUP", "DM", "TEAM" ] }, "description": "The type value" }, "onlyNamed": { "type": "boolean", "description": "Will only show named group conversations and team conversation" }, "x-organization-id": { "type": "integer", "description": "Required if using a multi organizations token" } }, "required": [ "PCID" ] } ``` *** ## maintainx\_organization\_list\_conversations\_members List conversation members **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ------------------------------ | | `id` | integer | Yes | — | ID of the conversation | | `cursor` | string | No | — | Last pagination reference | | `limit` | integer | No | — | max number of Members returned | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the conversation" }, "cursor": { "type": "string", "description": "Last pagination reference" }, "limit": { "type": "integer", "description": "max number of Members returned" } }, "required": [ "PCID", "id" ] } ``` *** ## maintainx\_organization\_list\_customfields List custom fields **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | -------------- | | `entity` | string | Yes | — | Type of entity | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "entity": { "type": "string", "description": "Type of entity", "enum": [ "assets", "locations", "parts", "workOrders", "vendors", "purchaseOrders", "lineItemPurchaseOrders" ] } }, "required": [ "PCID", "entity" ] } ``` *** ## maintainx\_organization\_list\_organizations List organizations **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ------------------------------------ | | `cursor` | string | No | — | Last pagination reference | | `limit` | integer | No | — | max number of Organizations returned | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cursor": { "type": "string", "description": "Last pagination reference" }, "limit": { "type": "integer", "description": "max number of Organizations returned" } }, "required": [ "PCID" ] } ``` *** ## maintainx\_organization\_list\_teams List teams **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | --------------------------------------------- | | `cursor` | string | No | — | Last pagination reference | | `limit` | integer | No | — | max number of Teams returned | | `x-organization-id` | integer | No | — | Required if using a multi organizations token | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cursor": { "type": "string", "description": "Last pagination reference" }, "limit": { "type": "integer", "description": "max number of Teams returned" }, "x-organization-id": { "type": "integer", "description": "Required if using a multi organizations token" } }, "required": [ "PCID" ] } ``` *** ## maintainx\_organization\_list\_teams\_members List team members **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ------------------------------ | | `cursor` | string | No | — | Last pagination reference | | `limit` | integer | No | — | max number of Members returned | | `id` | integer | Yes | — | ID of the team | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cursor": { "type": "string", "description": "Last pagination reference" }, "limit": { "type": "integer", "description": "max number of Members returned" }, "id": { "type": "integer", "description": "ID of the team" } }, "required": [ "PCID", "id" ] } ``` *** ## maintainx\_organization\_list\_users List users **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | --------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `cursor` | string | No | — | Last pagination reference | | `limit` | integer | No | — | max number of Users returned | | `onlyAssignable` | boolean | No | — | Will only show users that can be assigned to a work order | | `email` | string\[] | No | — | Filter users by email. You can filter for multiple users by specifying multiple emails like so: `/users?email=user1@example.com&email=user2@example.com`. Note that if you are using special characters in a url, you will need to URI encode them in order for us to interprete them correctly. For example, `+` should be encoded as `%2B` and though we accept `@`, they should still be encoded as `%40`. So filtering for email `user1+test@example.com`, you would use `/users?email=user1%2Btest%example.com` in your URI | | `expand` | string\[] | No | — | To expand multiple fields: `expand=role&expand=extra_fields` | | `x-organization-id` | integer | No | — | Required if using a multi organizations token | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "cursor": { "type": "string", "description": "Last pagination reference" }, "limit": { "type": "integer", "description": "max number of Users returned" }, "onlyAssignable": { "type": "boolean", "description": "Will only show users that can be assigned to a work order" }, "email": { "type": "array", "items": { "type": "string" }, "description": "Filter users by email. You can filter for multiple users by specifying multiple emails like so: `/users?email=user1@example.com&email=user2@example.com`. Note that if you are using special characters in a url, you will need to URI encode them in order for us to interprete them correctly. For example, `+` should be encoded as `%2B` and though we accept `@`, they should still be encoded as `%40`. So filtering for email `user1+test@example.com`, you would use `/users?email=user1%2Btest%example.com` in your URI" }, "expand": { "type": "array", "items": { "type": "string", "enum": [ "role", "extra_fields" ] }, "description": "To expand multiple fields: `expand=role&expand=extra_fields`" }, "x-organization-id": { "type": "integer", "description": "Required if using a multi organizations token" } }, "required": [ "PCID" ] } ``` *** ## maintainx\_organization\_send\_conversations\_messages Create new message in a conversation **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | integer | Yes | — | ID of the conversation | | `skipWebhook` | boolean | No | — | Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks | | `content` | string | Yes | — | Content of the message to post | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the conversation" }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" }, "content": { "type": "string", "description": "Content of the message to post" } }, "required": [ "PCID", "id", "content" ] } ``` *** ## maintainx\_organization\_send\_users\_messages Create new direct message to a user **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | integer | Yes | — | ID of the user | | `skipWebhook` | boolean | No | — | Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks | | `x-organization-id` | integer | No | — | Required if using a multi organizations token | | `content` | string | Yes | — | Content of the message to post | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the user" }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" }, "x-organization-id": { "type": "integer", "description": "Required if using a multi organizations token" }, "content": { "type": "string", "description": "Content of the message to post" } }, "required": [ "PCID", "id", "content" ] } ``` *** ## maintainx\_organization\_update\_categories Update category **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | integer | Yes | — | ID of the category | | `skipWebhook` | boolean | No | — | Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks | | `description` | string | No | — | Description field for additional information. | | `label` | string | No | — | Label used when displaying the category. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the category" }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" }, "description": { "type": "string", "description": "Description field for additional information." }, "label": { "type": "string", "description": "Label used when displaying the category." } }, "required": [ "PCID", "id" ] } ``` *** ## maintainx\_organization\_update\_customfields Edit custom field **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | integer | Yes | — | ID of the custom field | | `entity` | string | Yes | — | Type of entity | | `skipWebhook` | boolean | No | — | Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks | | `field` | object | No | — | The field value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the custom field" }, "entity": { "type": "string", "description": "Type of entity", "enum": [ "assets", "locations", "parts", "workOrders", "vendors", "purchaseOrders", "lineItemPurchaseOrders" ] }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" }, "field": { "type": "object", "description": "The field value", "properties": { "label": { "type": "string", "description": "The label value" }, "type": { "type": "string", "description": "The type value", "enum": [ "oneline", "multiline", "number", "singleSelect", "date", "datetime", "link" ] }, "options": { "type": "array", "items": { "type": "string" }, "description": "The options value" }, "includeInRecurrence": { "type": "boolean", "description": "Only relevent in the context of Work Orders" }, "sortIndex": { "type": "integer", "description": "Represents the actual index (zero based) that you wish the element to be set at. For example, if you have 6 custom fields, and would like to set the field as the second element, you would pass sortIndex: 1. This would in turn affect the sortOrder weight." }, "required": { "type": "boolean", "description": "Mark this custom field as required" }, "unlisted": { "type": "boolean", "description": "Mark this custom field as unlisted" } } } }, "required": [ "PCID", "id", "entity" ] } ``` *** ## maintainx\_organization\_update\_subscriptions Update subscription **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | integer | Yes | — | ID of the subscription | | `skipWebhook` | boolean | No | — | Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks | | `x-organization-id` | integer | No | — | Required if using a multi organizations token | | `type` | string | No | — | Type of event subscribed to | | `url` | string | No | — | The url value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the subscription" }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" }, "x-organization-id": { "type": "integer", "description": "Required if using a multi organizations token" }, "type": { "type": "string", "description": "Type of event subscribed to", "enum": [ "ASSET_STATUS_CHANGE", "METER_TRIGGER_STATE_CHANGE", "NEW_ASSET", "NEW_CATEGORY_ON_WORK_ORDER", "NEW_COMMENT_ON_WORK_ORDER", "NEW_LOCATION", "NEW_PART", "NEW_PURCHASE_ORDER", "NEW_SLASH_COMMAND", "NEW_VENDOR", "NEW_WORK_ORDER", "NEW_WORK_REQUEST", "PART_CHANGE", "PART_DELETE", "PART_QUANTITY_CHANGE", "PART_TRANSFER", "PURCHASE_ORDER_CHANGE", "PURCHASE_ORDER_STATUS_CHANGE", "WORK_ORDER_CHANGE", "WORK_ORDER_DELETE", "WORK_ORDER_OVERDUE", "WORK_ORDER_PART_STATUS_CHANGE", "WORK_ORDER_STATUS_CHANGE", "WORK_REQUEST_STATUS_CHANGE" ] }, "url": { "type": "string", "description": "The url value" } }, "required": [ "PCID", "id" ] } ``` *** ## maintainx\_organization\_update\_teams Update team **Parameters:** | Parameter | Type | Required | Default | Description | | -------------- | ---------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | `id` | integer | Yes | — | ID of the team | | `skipWebhook` | boolean | No | — | Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks | | `assetIds` | integer\[] | No | — | List of asset IDs that the team is responsible for | | `description` | string | No | — | The description value | | `locationIds` | integer\[] | No | — | List of location where the team is operating | | `membersCount` | integer | No | — | Number of team members | | `name` | string | No | — | The name value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the team" }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" }, "assetIds": { "type": "array", "items": { "type": "integer" }, "description": "List of asset IDs that the team is responsible for" }, "description": { "type": "string", "description": "The description value" }, "locationIds": { "type": "array", "items": { "type": "integer" }, "description": "List of location where the team is operating" }, "membersCount": { "type": "integer", "description": "Number of team members" }, "name": { "type": "string", "description": "The name value" } }, "required": [ "PCID", "id" ] } ``` *** ## maintainx\_organization\_update\_teams\_members Update team member **Parameters:** | Parameter | Type | Required | Default | Description | | ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | | `teamId` | integer | Yes | — | ID of the team | | `userId` | integer | Yes | — | User ID of the member | | `skipWebhook` | boolean | No | — | Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks | | `teamRole` | string | No | — | Team Role | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "teamId": { "type": "integer", "description": "ID of the team" }, "userId": { "type": "integer", "description": "User ID of the member" }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" }, "teamRole": { "type": "string", "description": "Team Role", "enum": [ "ADMIN", "MEMBER" ] } }, "required": [ "PCID", "teamId", "userId" ] } ``` *** ## maintainx\_organization\_update\_users Update user **Parameters:** | Parameter | Type | Required | Default | Description | | | ------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | integer | Yes | — | ID of the user | | | `skipWebhook` | boolean | No | — | Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks | | | `x-organization-id` | integer | No | — | Required if using a multi organizations token | | | `authType` | string | null | No | — | Auth Type | | `customRole` | string | null | No | — | Custom role name if the user has a custom role assigned | | `email` | string | null | No | — | The email value | | `externalData` | object | No | — | Extra data that can be attached to the user, for example to help reference to a matching record in an external system. | | | `extraFields` | object | No | — | Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: "Department") | | | `firstName` | string | No | — | First Name | | | `hourlyRate` | integer | null | No | — | Cost in cents. For example, for \$1.20, put 120. Set to `null` to set the user's rate to organization default hourly rate if defined, otherwise it would set the rate to the user's hourly rate defined in any work order. If none is defined, setting `null` will set the user's hourly rate to `null` | | `lastName` | string | No | — | Last Name | | | `phoneNumber` | string | null | No | — | Phone Number | | `role` | string | null | No | — | The role value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "ID of the user" }, "skipWebhook": { "type": "boolean", "description": "Set `skipWebhook=true`, `skipWebhook=1` or `skipWebhook=yes` to skip all webhooks upon successful operation on the endpoint. [Learn more about webhooks](#tag/Subscriptions-and-Webhooks)" }, "x-organization-id": { "type": "integer", "description": "Required if using a multi organizations token" }, "authType": { "type": [ "string", "null" ], "description": "Auth Type", "enum": [ "NORMAL", "SAML" ] }, "customRole": { "type": [ "string", "null" ], "description": "Custom role name if the user has a custom role assigned" }, "email": { "type": [ "string", "null" ], "description": "The email value" }, "externalData": { "description": "Extra data that can be attached to the user, for example to help reference to a matching record in an external system." }, "extraFields": { "type": "object", "description": "Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: \"Department\")" }, "firstName": { "type": "string", "description": "First Name" }, "hourlyRate": { "type": [ "integer", "null" ], "description": "Cost in cents. For example, for $1.20, put 120. Set to `null` to set the user's rate to organization default hourly rate if defined, otherwise it would set the rate to the user's hourly rate defined in any work order. If none is defined, setting `null` will set the user's hourly rate to `null`" }, "lastName": { "type": "string", "description": "Last Name" }, "phoneNumber": { "type": [ "string", "null" ], "description": "Phone Number" }, "role": { "type": [ "string", "null" ], "description": "The role value", "enum": [ "ADMIN", "MEMBER", "REQUESTER", "SERVICE_ACCOUNT" ] } }, "required": [ "PCID", "id" ] } ```