> ## 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.

# invgate-service-management-users

> InvGate Users & Organizations - manage users, companies, groups, and locations

**Server path:** `/invgate-service-management-users` | **Type:** Application | **PCID required:** Yes

## Tools

| Tool                                                                                                                          | Description                |
| ----------------------------------------------------------------------------------------------------------------------------- | -------------------------- |
| [`invgate_service_management_users_add_users_to_company`](#invgate_service_management_users_add_users_to_company)             | Add users to company       |
| [`invgate_service_management_users_add_users_to_group`](#invgate_service_management_users_add_users_to_group)                 | Add users to group         |
| [`invgate_service_management_users_add_users_to_location`](#invgate_service_management_users_add_users_to_location)           | Add users to location      |
| [`invgate_service_management_users_convert_user_type`](#invgate_service_management_users_convert_user_type)                   | Convert user type          |
| [`invgate_service_management_users_create_company`](#invgate_service_management_users_create_company)                         | Create company             |
| [`invgate_service_management_users_create_group`](#invgate_service_management_users_create_group)                             | Create user group          |
| [`invgate_service_management_users_create_location`](#invgate_service_management_users_create_location)                       | Create location            |
| [`invgate_service_management_users_create_user`](#invgate_service_management_users_create_user)                               | Create user                |
| [`invgate_service_management_users_delete_company`](#invgate_service_management_users_delete_company)                         | Delete company             |
| [`invgate_service_management_users_delete_group`](#invgate_service_management_users_delete_group)                             | Delete user group          |
| [`invgate_service_management_users_delete_location`](#invgate_service_management_users_delete_location)                       | Delete location            |
| [`invgate_service_management_users_delete_user`](#invgate_service_management_users_delete_user)                               | Delete user                |
| [`invgate_service_management_users_disable_user`](#invgate_service_management_users_disable_user)                             | Disable user               |
| [`invgate_service_management_users_enable_user`](#invgate_service_management_users_enable_user)                               | Enable user                |
| [`invgate_service_management_users_get_user`](#invgate_service_management_users_get_user)                                     | Get user                   |
| [`invgate_service_management_users_get_user_by_filter`](#invgate_service_management_users_get_user_by_filter)                 | Get user by filter         |
| [`invgate_service_management_users_list_companies`](#invgate_service_management_users_list_companies)                         | List companies             |
| [`invgate_service_management_users_list_company_users`](#invgate_service_management_users_list_company_users)                 | List company users         |
| [`invgate_service_management_users_list_group_users`](#invgate_service_management_users_list_group_users)                     | List group users           |
| [`invgate_service_management_users_list_groups`](#invgate_service_management_users_list_groups)                               | List user groups           |
| [`invgate_service_management_users_list_help_desks`](#invgate_service_management_users_list_help_desks)                       | List help desks            |
| [`invgate_service_management_users_list_location_users`](#invgate_service_management_users_list_location_users)               | List location users        |
| [`invgate_service_management_users_list_locations`](#invgate_service_management_users_list_locations)                         | List locations             |
| [`invgate_service_management_users_list_user_groups`](#invgate_service_management_users_list_user_groups)                     | List user's groups         |
| [`invgate_service_management_users_list_users`](#invgate_service_management_users_list_users)                                 | List users                 |
| [`invgate_service_management_users_list_users_by_filter`](#invgate_service_management_users_list_users_by_filter)             | List users by filter       |
| [`invgate_service_management_users_remove_users_from_company`](#invgate_service_management_users_remove_users_from_company)   | Remove users from company  |
| [`invgate_service_management_users_remove_users_from_group`](#invgate_service_management_users_remove_users_from_group)       | Remove users from group    |
| [`invgate_service_management_users_remove_users_from_location`](#invgate_service_management_users_remove_users_from_location) | Remove users from location |
| [`invgate_service_management_users_update_company`](#invgate_service_management_users_update_company)                         | Update company             |
| [`invgate_service_management_users_update_user`](#invgate_service_management_users_update_user)                               | Update user                |

***

## invgate\_service\_management\_users\_add\_users\_to\_company

Add users to company

**Parameters:**

| Parameter | Type       | Required | Default | Description             |
| --------- | ---------- | -------- | ------- | ----------------------- |
| `id`      | integer    | Yes      | —       | Company ID              |
| `users`   | integer\[] | Yes      | —       | List of user IDs to add |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "Company ID"
      },
      "users": {
        "type": "array",
        "items": {
          "type": "integer"
        },
        "description": "List of user IDs to add"
      }
    },
    "required": [
      "PCID",
      "id",
      "users"
    ]
  }
  ```
</Expandable>

***

## invgate\_service\_management\_users\_add\_users\_to\_group

Add users to group

**Parameters:**

| Parameter | Type       | Required | Default | Description             |
| --------- | ---------- | -------- | ------- | ----------------------- |
| `id`      | integer    | Yes      | —       | Group ID                |
| `users`   | integer\[] | Yes      | —       | List of user IDs to add |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "Group ID"
      },
      "users": {
        "type": "array",
        "items": {
          "type": "integer"
        },
        "description": "List of user IDs to add"
      }
    },
    "required": [
      "PCID",
      "id",
      "users"
    ]
  }
  ```
</Expandable>

***

## invgate\_service\_management\_users\_add\_users\_to\_location

Add users to location

**Parameters:**

| Parameter | Type       | Required | Default | Description             |
| --------- | ---------- | -------- | ------- | ----------------------- |
| `id`      | integer    | Yes      | —       | Location ID             |
| `users`   | integer\[] | Yes      | —       | List of user IDs to add |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "Location ID"
      },
      "users": {
        "type": "array",
        "items": {
          "type": "integer"
        },
        "description": "List of user IDs to add"
      }
    },
    "required": [
      "PCID",
      "id",
      "users"
    ]
  }
  ```
</Expandable>

***

## invgate\_service\_management\_users\_convert\_user\_type

Convert user type

**Parameters:**

| Parameter  | Type    | Required | Default | Description                                                        |
| ---------- | ------- | -------- | ------- | ------------------------------------------------------------------ |
| `id`       | integer | Yes      | —       | User ID                                                            |
| `is_agent` | boolean | Yes      | —       | Whether to convert the user to an agent (true) or end user (false) |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "User ID"
      },
      "is_agent": {
        "type": "boolean",
        "description": "Whether to convert the user to an agent (true) or end user (false)"
      }
    },
    "required": [
      "PCID",
      "id",
      "is_agent"
    ]
  }
  ```
</Expandable>

***

## invgate\_service\_management\_users\_create\_company

Create company

**Parameters:**

| Parameter     | Type   | Required | Default | Description                         |
| ------------- | ------ | -------- | ------- | ----------------------------------- |
| `external_id` | string | No       | —       | External identifier for the company |
| `name`        | string | Yes      | —       | Name of the company                 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "external_id": {
        "type": "string",
        "description": "External identifier for the company"
      },
      "name": {
        "type": "string",
        "description": "Name of the company"
      }
    },
    "required": [
      "PCID",
      "name"
    ]
  }
  ```
</Expandable>

***

## invgate\_service\_management\_users\_create\_group

Create user group

**Parameters:**

| Parameter | Type   | Required | Default | Description       |
| --------- | ------ | -------- | ------- | ----------------- |
| `name`    | string | Yes      | —       | Name of the group |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "name": {
        "type": "string",
        "description": "Name of the group"
      }
    },
    "required": [
      "PCID",
      "name"
    ]
  }
  ```
</Expandable>

***

## invgate\_service\_management\_users\_create\_location

Create location

**Parameters:**

| Parameter   | Type    | Required | Default | Description          |
| ----------- | ------- | -------- | ------- | -------------------- |
| `name`      | string  | Yes      | —       | Name of the location |
| `parent_id` | integer | No       | —       | Parent location ID   |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "name": {
        "type": "string",
        "description": "Name of the location"
      },
      "parent_id": {
        "type": "integer",
        "description": "Parent location ID"
      }
    },
    "required": [
      "PCID",
      "name"
    ]
  }
  ```
</Expandable>

***

## invgate\_service\_management\_users\_create\_user

Create user

**Parameters:**

| Parameter     | Type       | Required | Default | Description                             |
| ------------- | ---------- | -------- | ------- | --------------------------------------- |
| `company_id`  | integer    | No       | —       | Company ID for the user                 |
| `email`       | string     | Yes      | —       | User email address                      |
| `first_name`  | string     | Yes      | —       | User first name                         |
| `group_ids`   | integer\[] | No       | —       | List of group IDs to assign the user to |
| `is_agent`    | boolean    | No       | —       | Whether the user is an agent            |
| `last_name`   | string     | Yes      | —       | User last name                          |
| `location_id` | integer    | No       | —       | Location ID for the user                |
| `mobile`      | string     | No       | —       | User mobile number                      |
| `phone`       | string     | No       | —       | User phone number                       |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "company_id": {
        "type": "integer",
        "description": "Company ID for the user"
      },
      "email": {
        "type": "string",
        "description": "User email address"
      },
      "first_name": {
        "type": "string",
        "description": "User first name"
      },
      "group_ids": {
        "type": "array",
        "items": {
          "type": "integer"
        },
        "description": "List of group IDs to assign the user to"
      },
      "is_agent": {
        "type": "boolean",
        "description": "Whether the user is an agent"
      },
      "last_name": {
        "type": "string",
        "description": "User last name"
      },
      "location_id": {
        "type": "integer",
        "description": "Location ID for the user"
      },
      "mobile": {
        "type": "string",
        "description": "User mobile number"
      },
      "phone": {
        "type": "string",
        "description": "User phone number"
      }
    },
    "required": [
      "PCID",
      "email",
      "first_name",
      "last_name"
    ]
  }
  ```
</Expandable>

***

## invgate\_service\_management\_users\_delete\_company

Delete company

**Parameters:**

| Parameter | Type    | Required | Default | Description          |
| --------- | ------- | -------- | ------- | -------------------- |
| `id`      | integer | Yes      | —       | Company ID to delete |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "Company ID to delete"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## invgate\_service\_management\_users\_delete\_group

Delete user group

**Parameters:**

| Parameter | Type    | Required | Default | Description        |
| --------- | ------- | -------- | ------- | ------------------ |
| `id`      | integer | Yes      | —       | Group ID to delete |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "Group ID to delete"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## invgate\_service\_management\_users\_delete\_location

Delete location

**Parameters:**

| Parameter | Type    | Required | Default | Description           |
| --------- | ------- | -------- | ------- | --------------------- |
| `id`      | integer | Yes      | —       | Location ID to delete |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "Location ID to delete"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## invgate\_service\_management\_users\_delete\_user

Delete user

**Parameters:**

| Parameter | Type    | Required | Default | Description       |
| --------- | ------- | -------- | ------- | ----------------- |
| `id`      | integer | Yes      | —       | User ID to delete |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "User ID to delete"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## invgate\_service\_management\_users\_disable\_user

Disable user

**Parameters:**

| Parameter | Type    | Required | Default | Description        |
| --------- | ------- | -------- | ------- | ------------------ |
| `id`      | integer | Yes      | —       | User ID to disable |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "User ID to disable"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## invgate\_service\_management\_users\_enable\_user

Enable user

**Parameters:**

| Parameter | Type    | Required | Default | Description       |
| --------- | ------- | -------- | ------- | ----------------- |
| `id`      | integer | Yes      | —       | User ID to enable |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "User ID to enable"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## invgate\_service\_management\_users\_get\_user

Get user

**Parameters:**

| Parameter  | Type    | Required | Default | Description        |
| ---------- | ------- | -------- | ------- | ------------------ |
| `id`       | integer | No       | —       | User ID            |
| `email`    | string  | No       | —       | User email address |
| `username` | string  | No       | —       | The username value |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "User ID"
      },
      "email": {
        "type": "string",
        "description": "User email address"
      },
      "username": {
        "type": "string",
        "description": "The username value"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## invgate\_service\_management\_users\_get\_user\_by\_filter

Get user by filter

**Parameters:**

| Parameter     | Type    | Required | Default | Description        |
| ------------- | ------- | -------- | ------- | ------------------ |
| `id`          | integer | No       | —       | User ID            |
| `email`       | string  | No       | —       | User email address |
| `username`    | string  | No       | —       | The username value |
| `external_id` | string  | No       | —       | External user ID   |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "User ID"
      },
      "email": {
        "type": "string",
        "description": "User email address"
      },
      "username": {
        "type": "string",
        "description": "The username value"
      },
      "external_id": {
        "type": "string",
        "description": "External user ID"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## invgate\_service\_management\_users\_list\_companies

List companies

**Parameters:**

| Parameter     | Type    | Required | Default | Description            |
| ------------- | ------- | -------- | ------- | ---------------------- |
| `external_id` | string  | No       | —       | Filter by external ID  |
| `id`          | integer | No       | —       | Filter by company ID   |
| `name`        | string  | No       | —       | Filter by company name |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "external_id": {
        "type": "string",
        "description": "Filter by external ID"
      },
      "id": {
        "type": "integer",
        "description": "Filter by company ID"
      },
      "name": {
        "type": "string",
        "description": "Filter by company name"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## invgate\_service\_management\_users\_list\_company\_users

List company users

**Parameters:**

| Parameter | Type    | Required | Default | Description                |
| --------- | ------- | -------- | ------- | -------------------------- |
| `id`      | integer | Yes      | —       | Company ID                 |
| `user_id` | integer | No       | —       | Filter by specific user ID |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "Company ID"
      },
      "user_id": {
        "type": "integer",
        "description": "Filter by specific user ID"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## invgate\_service\_management\_users\_list\_group\_users

List group users

**Parameters:**

| Parameter | Type    | Required | Default | Description                |
| --------- | ------- | -------- | ------- | -------------------------- |
| `id`      | integer | Yes      | —       | Group ID                   |
| `user_id` | integer | No       | —       | Filter by specific user ID |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "Group ID"
      },
      "user_id": {
        "type": "integer",
        "description": "Filter by specific user ID"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## invgate\_service\_management\_users\_list\_groups

List user groups

**Parameters:**

| Parameter | Type    | Required | Default | Description          |
| --------- | ------- | -------- | ------- | -------------------- |
| `id`      | integer | No       | —       | Filter by group ID   |
| `name`    | string  | No       | —       | Filter by group name |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "Filter by group ID"
      },
      "name": {
        "type": "string",
        "description": "Filter by group name"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## invgate\_service\_management\_users\_list\_help\_desks

List help desks

**Parameters:**

| Parameter         | Type    | Required | Default | Description                           |
| ----------------- | ------- | -------- | ------- | ------------------------------------- |
| `id`              | integer | No       | —       | Filter by help desk ID                |
| `include_deleted` | boolean | No       | —       | Whether to include deleted help desks |
| `name`            | string  | No       | —       | Filter by help desk name              |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "Filter by help desk ID"
      },
      "include_deleted": {
        "type": "boolean",
        "description": "Whether to include deleted help desks"
      },
      "name": {
        "type": "string",
        "description": "Filter by help desk name"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## invgate\_service\_management\_users\_list\_location\_users

List location users

**Parameters:**

| Parameter | Type    | Required | Default | Description                |
| --------- | ------- | -------- | ------- | -------------------------- |
| `id`      | integer | Yes      | —       | Location ID                |
| `user_id` | integer | No       | —       | Filter by specific user ID |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "Location ID"
      },
      "user_id": {
        "type": "integer",
        "description": "Filter by specific user ID"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## invgate\_service\_management\_users\_list\_locations

List locations

**Parameters:**

| Parameter | Type    | Required | Default | Description             |
| --------- | ------- | -------- | ------- | ----------------------- |
| `id`      | integer | No       | —       | Filter by location ID   |
| `name`    | string  | No       | —       | Filter by location name |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "Filter by location ID"
      },
      "name": {
        "type": "string",
        "description": "Filter by location name"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## invgate\_service\_management\_users\_list\_user\_groups

List user's groups

**Parameters:**

| Parameter | Type    | Required | Default | Description |
| --------- | ------- | -------- | ------- | ----------- |
| `id`      | integer | Yes      | —       | User ID     |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "User ID"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## invgate\_service\_management\_users\_list\_users

List users

**Parameters:**

| Parameter   | Type    | Required | Default | Description                |
| ----------- | ------- | -------- | ------- | -------------------------- |
| `page`      | integer | No       | —       | Page number                |
| `page_size` | integer | No       | —       | Number of results per page |
| `is_agent`  | boolean | No       | —       | Filter by agent status     |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "page": {
        "type": "integer",
        "description": "Page number"
      },
      "page_size": {
        "type": "integer",
        "description": "Number of results per page"
      },
      "is_agent": {
        "type": "boolean",
        "description": "Filter by agent status"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## invgate\_service\_management\_users\_list\_users\_by\_filter

List users by filter

**Parameters:**

| Parameter     | Type    | Required | Default | Description            |
| ------------- | ------- | -------- | ------- | ---------------------- |
| `group_id`    | integer | No       | —       | Filter by group ID     |
| `company_id`  | integer | No       | —       | Filter by company ID   |
| `location_id` | integer | No       | —       | Filter by location ID  |
| `is_agent`    | boolean | No       | —       | Filter by agent status |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "group_id": {
        "type": "integer",
        "description": "Filter by group ID"
      },
      "company_id": {
        "type": "integer",
        "description": "Filter by company ID"
      },
      "location_id": {
        "type": "integer",
        "description": "Filter by location ID"
      },
      "is_agent": {
        "type": "boolean",
        "description": "Filter by agent status"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## invgate\_service\_management\_users\_remove\_users\_from\_company

Remove users from company

**Parameters:**

| Parameter | Type       | Required | Default | Description                |
| --------- | ---------- | -------- | ------- | -------------------------- |
| `id`      | integer    | Yes      | —       | Company ID                 |
| `users`   | integer\[] | Yes      | —       | List of user IDs to remove |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "Company ID"
      },
      "users": {
        "type": "array",
        "items": {
          "type": "integer"
        },
        "description": "List of user IDs to remove"
      }
    },
    "required": [
      "PCID",
      "id",
      "users"
    ]
  }
  ```
</Expandable>

***

## invgate\_service\_management\_users\_remove\_users\_from\_group

Remove users from group

**Parameters:**

| Parameter | Type       | Required | Default | Description                |
| --------- | ---------- | -------- | ------- | -------------------------- |
| `id`      | integer    | Yes      | —       | Group ID                   |
| `users`   | integer\[] | Yes      | —       | List of user IDs to remove |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "Group ID"
      },
      "users": {
        "type": "array",
        "items": {
          "type": "integer"
        },
        "description": "List of user IDs to remove"
      }
    },
    "required": [
      "PCID",
      "id",
      "users"
    ]
  }
  ```
</Expandable>

***

## invgate\_service\_management\_users\_remove\_users\_from\_location

Remove users from location

**Parameters:**

| Parameter | Type       | Required | Default | Description                |
| --------- | ---------- | -------- | ------- | -------------------------- |
| `id`      | integer    | Yes      | —       | Location ID                |
| `users`   | integer\[] | Yes      | —       | List of user IDs to remove |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "Location ID"
      },
      "users": {
        "type": "array",
        "items": {
          "type": "integer"
        },
        "description": "List of user IDs to remove"
      }
    },
    "required": [
      "PCID",
      "id",
      "users"
    ]
  }
  ```
</Expandable>

***

## invgate\_service\_management\_users\_update\_company

Update company

**Parameters:**

| Parameter     | Type    | Required | Default | Description                         |
| ------------- | ------- | -------- | ------- | ----------------------------------- |
| `external_id` | string  | No       | —       | External identifier for the company |
| `id`          | integer | Yes      | —       | Company ID                          |
| `name`        | string  | No       | —       | Name of the company                 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "external_id": {
        "type": "string",
        "description": "External identifier for the company"
      },
      "id": {
        "type": "integer",
        "description": "Company ID"
      },
      "name": {
        "type": "string",
        "description": "Name of the company"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## invgate\_service\_management\_users\_update\_user

Update user

**Parameters:**

| Parameter     | Type    | Required | Default | Description                  |
| ------------- | ------- | -------- | ------- | ---------------------------- |
| `company_id`  | integer | No       | —       | Company ID for the user      |
| `email`       | string  | No       | —       | User email address           |
| `first_name`  | string  | No       | —       | User first name              |
| `id`          | integer | Yes      | —       | User ID                      |
| `is_agent`    | boolean | No       | —       | Whether the user is an agent |
| `last_name`   | string  | No       | —       | User last name               |
| `location_id` | integer | No       | —       | Location ID for the user     |
| `mobile`      | string  | No       | —       | User mobile number           |
| `phone`       | string  | No       | —       | User phone number            |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "company_id": {
        "type": "integer",
        "description": "Company ID for the user"
      },
      "email": {
        "type": "string",
        "description": "User email address"
      },
      "first_name": {
        "type": "string",
        "description": "User first name"
      },
      "id": {
        "type": "integer",
        "description": "User ID"
      },
      "is_agent": {
        "type": "boolean",
        "description": "Whether the user is an agent"
      },
      "last_name": {
        "type": "string",
        "description": "User last name"
      },
      "location_id": {
        "type": "integer",
        "description": "Location ID for the user"
      },
      "mobile": {
        "type": "string",
        "description": "User mobile number"
      },
      "phone": {
        "type": "string",
        "description": "User phone number"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>