{
  "opencollection": "1.0.0",
  "info": {
    "name": "Helpcenter Users API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Users",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Transfer User",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/users/:userId/actions/transfer_and_delete",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "User ID to be transferred and deleted"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Transfer user records, assignments, and criteria to another user"
        },
        {
          "info": {
            "name": "Get Transfer Status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/users/actions/transfer_and_delete",
            "params": [
              {
                "name": "job_id",
                "value": "",
                "type": "query",
                "description": "Unique identifier for the transfer job to check status"
              }
            ]
          },
          "docs": "Retrieve the status of a user transfer operation using the job ID"
        },
        {
          "info": {
            "name": "Transfer User",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/users/actions/transfer_and_delete",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Transfer user records, assignments, and criteria to another user"
        },
        {
          "info": {
            "name": "Transfer User",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/users/:userId/actions/transfer",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "User ID to be transferred and deleted"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Transfer user records, assignments, and criteria to another user"
        },
        {
          "info": {
            "name": "Get Transfer Status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/users/actions/transfer",
            "params": [
              {
                "name": "job_id",
                "value": "",
                "type": "query",
                "description": "Unique identifier for the transfer job to check status"
              }
            ]
          },
          "docs": "Retrieve the status of a user transfer operation using the job ID"
        },
        {
          "info": {
            "name": "Get Transfer Status",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/users/:userId/actions/validate_before_transfer",
            "params": [
              {
                "name": "userId",
                "value": "",
                "type": "path",
                "description": "User ID to be transferred and deleted"
              }
            ]
          },
          "docs": "Retrieve the status of a user transfer operation using the job ID"
        },
        {
          "info": {
            "name": "Get Associated Groups for User",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/users/:user/actions/associated_groups",
            "params": [
              {
                "name": "user",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the user"
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Additional data to include in the response"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number to retrieve"
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "Number of items to return per page"
              }
            ]
          },
          "docs": "Get the list of user groups associated with the specified user."
        },
        {
          "info": {
            "name": "Get Territories of User",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/users/:user/territories",
            "params": [
              {
                "name": "user",
                "value": "",
                "type": "path",
                "description": "The ID of the user"
              }
            ]
          },
          "docs": "Get Territories Assigned to a User"
        },
        {
          "info": {
            "name": "Associate Territories to User",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/users/:user/territories",
            "params": [
              {
                "name": "user",
                "value": "",
                "type": "path",
                "description": "The ID of the user"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Associate Territories to a User"
        },
        {
          "info": {
            "name": "Remove Territories from User",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/users/:user/territories",
            "params": [
              {
                "name": "user",
                "value": "",
                "type": "path",
                "description": "The ID of the user"
              },
              {
                "name": "ids",
                "value": "",
                "type": "query",
                "description": "Comma-separated IDs (each ID is an int64)"
              }
            ]
          },
          "docs": "Remove Territories from a User"
        },
        {
          "info": {
            "name": "Get specific Territory of User",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/users/:user/territories/:territory",
            "params": [
              {
                "name": "user",
                "value": "",
                "type": "path",
                "description": "The ID of the user"
              },
              {
                "name": "territory",
                "value": "",
                "type": "path",
                "description": "The ID of the territory"
              }
            ]
          },
          "docs": "Get specific territory of a user"
        },
        {
          "info": {
            "name": "Remove Territory from User",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/users/:user/territories/:territory",
            "params": [
              {
                "name": "user",
                "value": "",
                "type": "path",
                "description": "The ID of the user"
              },
              {
                "name": "territory",
                "value": "",
                "type": "path",
                "description": "The ID of the territory"
              }
            ]
          },
          "docs": "Remove Territory from a User"
        },
        {
          "info": {
            "name": "Get users",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/users",
            "params": [
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "type of users"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Current page number"
              },
              {
                "name": "per_page",
                "value": "",
                "type": "query",
                "description": "Number of records per page"
              },
              {
                "name": "type__s",
                "value": "",
                "type": "query",
                "description": "type"
              }
            ]
          },
          "docs": "To get all users based on the provided parameters."
        },
        {
          "info": {
            "name": "Create User",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/users",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new user in the organization. API exposed to customers"
        },
        {
          "info": {
            "name": "Update User",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/users",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update multiple users. API exposed to customers"
        },
        {
          "info": {
            "name": "Get user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/users/:user",
            "params": [
              {
                "name": "user",
                "value": "",
                "type": "path",
                "description": "user Id"
              }
            ]
          },
          "docs": "To get a single user based on the provided user ID."
        },
        {
          "info": {
            "name": "Update User",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/users/:user",
            "params": [
              {
                "name": "user",
                "value": "",
                "type": "path",
                "description": "user Id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update single user by ID. API exposed to customers"
        },
        {
          "info": {
            "name": "Delete a User",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/users/:user",
            "params": [
              {
                "name": "user",
                "value": "",
                "type": "path",
                "description": "user Id"
              }
            ]
          },
          "docs": "Delete a user by ID. API exposed to customers"
        }
      ]
    }
  ],
  "bundled": true
}