{
  "info": {
    "_postman_id": "da2a9c1c-ec8f-495d-9493-3036ae198e5f",
    "name": "BetterCloud Platform Events Users API",
    "description": "The BetterCloud Platform API provides REST API access for managing SaaS application operations, automated workflows, user lifecycle management, and security policies across enterprise SaaS environments. It enables IT and security teams to programmatically manage users, groups, directories, and automation workflows across 100+ integrated SaaS applications.\n\nContact Support:\n Name: BetterCloud Developer Support",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
    "createdAt": "2026-07-28T01:12:09.000Z",
    "updatedAt": "2026-07-28T01:12:10.000Z",
    "lastUpdatedBy": "35240",
    "uid": "35240-da2a9c1c-ec8f-495d-9493-3036ae198e5f"
  },
  "item": [
    {
      "name": "users",
      "item": [
        {
          "name": "{id}",
          "item": [
            {
              "name": "suspend",
              "item": [
                {
                  "name": "BetterCloud Suspend User",
                  "id": "f960b959-146c-4386-b82b-d23ba59d21bc",
                  "protocolProfileBehavior": {
                    "disableBodyPruning": true
                  },
                  "request": {
                    "method": "POST",
                    "header": [
                      {
                        "key": "Accept",
                        "value": "application/json"
                      }
                    ],
                    "url": {
                      "raw": "{{baseUrl}}/users/:id/suspend",
                      "host": [
                        "{{baseUrl}}"
                      ],
                      "path": [
                        "users",
                        ":id",
                        "suspend"
                      ],
                      "variable": [
                        {
                          "id": "070a2264-e55b-4a6f-b2ae-b27131675fcf",
                          "key": "id",
                          "value": "<string>",
                          "description": "(Required) The unique identifier of the user."
                        }
                      ]
                    },
                    "description": "Suspends a user across all integrated SaaS applications."
                  },
                  "response": [
                    {
                      "id": "15a2f740-1ce8-4de1-87a9-562a4736cbe6",
                      "name": "User suspended successfully.",
                      "originalRequest": {
                        "method": "POST",
                        "header": [
                          {
                            "key": "Accept",
                            "value": "application/json"
                          },
                          {
                            "description": "Added as a part of security scheme: apikey",
                            "key": "X-API-Key",
                            "value": "<API Key>"
                          }
                        ],
                        "url": {
                          "raw": "{{baseUrl}}/users/:id/suspend",
                          "host": [
                            "{{baseUrl}}"
                          ],
                          "path": [
                            "users",
                            ":id",
                            "suspend"
                          ],
                          "variable": [
                            {
                              "key": "id"
                            }
                          ]
                        }
                      },
                      "status": "OK",
                      "code": 200,
                      "_postman_previewlanguage": "json",
                      "header": [
                        {
                          "key": "Content-Type",
                          "value": "application/json"
                        }
                      ],
                      "cookie": [],
                      "responseTime": null,
                      "body": "{\n  \"data\": {\n    \"id\": \"<string>\",\n    \"email\": \"<email>\",\n    \"first_name\": \"<string>\",\n    \"last_name\": \"<string>\",\n    \"status\": \"deprovisioned\",\n    \"department\": \"<string>\",\n    \"title\": \"<string>\",\n    \"manager_email\": \"<email>\",\n    \"location\": \"<string>\",\n    \"created_at\": \"<dateTime>\",\n    \"updated_at\": \"<dateTime>\"\n  }\n}",
                      "createdAt": "2026-07-28T01:12:10.000Z",
                      "updatedAt": "2026-07-28T01:12:10.000Z",
                      "uid": "35240-15a2f740-1ce8-4de1-87a9-562a4736cbe6"
                    }
                  ],
                  "createdAt": "2026-07-28T01:12:10.000Z",
                  "updatedAt": "2026-07-28T01:12:10.000Z",
                  "uid": "35240-f960b959-146c-4386-b82b-d23ba59d21bc"
                }
              ],
              "id": "47f7c71e-1869-4a0f-af23-461c697c4ec3",
              "createdAt": "2026-07-28T01:12:10.000Z",
              "updatedAt": "2026-07-28T01:12:10.000Z",
              "uid": "35240-47f7c71e-1869-4a0f-af23-461c697c4ec3"
            },
            {
              "name": "deprovision",
              "item": [
                {
                  "name": "BetterCloud Deprovision User",
                  "id": "d00c795a-c4b1-4199-ba7c-260f070db2e3",
                  "protocolProfileBehavior": {
                    "disableBodyPruning": true
                  },
                  "request": {
                    "method": "POST",
                    "header": [
                      {
                        "key": "Accept",
                        "value": "application/json"
                      }
                    ],
                    "url": {
                      "raw": "{{baseUrl}}/users/:id/deprovision",
                      "host": [
                        "{{baseUrl}}"
                      ],
                      "path": [
                        "users",
                        ":id",
                        "deprovision"
                      ],
                      "variable": [
                        {
                          "id": "43de9043-34d8-446d-8415-b3327fcac1f5",
                          "key": "id",
                          "value": "<string>",
                          "description": "(Required) The unique identifier of the user."
                        }
                      ]
                    },
                    "description": "Deprovisions a user and removes access across all integrated SaaS applications."
                  },
                  "response": [
                    {
                      "id": "cd50662d-f9cd-49bd-a3e1-3ad080ea2fa0",
                      "name": "User deprovisioned successfully.",
                      "originalRequest": {
                        "method": "POST",
                        "header": [
                          {
                            "key": "Accept",
                            "value": "application/json"
                          },
                          {
                            "description": "Added as a part of security scheme: apikey",
                            "key": "X-API-Key",
                            "value": "<API Key>"
                          }
                        ],
                        "url": {
                          "raw": "{{baseUrl}}/users/:id/deprovision",
                          "host": [
                            "{{baseUrl}}"
                          ],
                          "path": [
                            "users",
                            ":id",
                            "deprovision"
                          ],
                          "variable": [
                            {
                              "key": "id"
                            }
                          ]
                        }
                      },
                      "status": "OK",
                      "code": 200,
                      "_postman_previewlanguage": "json",
                      "header": [
                        {
                          "key": "Content-Type",
                          "value": "application/json"
                        }
                      ],
                      "cookie": [],
                      "responseTime": null,
                      "body": "{\n  \"data\": {\n    \"id\": \"<string>\",\n    \"email\": \"<email>\",\n    \"first_name\": \"<string>\",\n    \"last_name\": \"<string>\",\n    \"status\": \"deprovisioned\",\n    \"department\": \"<string>\",\n    \"title\": \"<string>\",\n    \"manager_email\": \"<email>\",\n    \"location\": \"<string>\",\n    \"created_at\": \"<dateTime>\",\n    \"updated_at\": \"<dateTime>\"\n  }\n}",
                      "createdAt": "2026-07-28T01:12:10.000Z",
                      "updatedAt": "2026-07-28T01:12:10.000Z",
                      "uid": "35240-cd50662d-f9cd-49bd-a3e1-3ad080ea2fa0"
                    }
                  ],
                  "createdAt": "2026-07-28T01:12:10.000Z",
                  "updatedAt": "2026-07-28T01:12:10.000Z",
                  "uid": "35240-d00c795a-c4b1-4199-ba7c-260f070db2e3"
                }
              ],
              "id": "611af50e-b9b9-46bd-913f-639b6ae2ca09",
              "createdAt": "2026-07-28T01:12:10.000Z",
              "updatedAt": "2026-07-28T01:12:10.000Z",
              "uid": "35240-611af50e-b9b9-46bd-913f-639b6ae2ca09"
            },
            {
              "name": "BetterCloud Get User",
              "id": "6bc2150e-1334-489a-99f7-2c6518528526",
              "protocolProfileBehavior": {
                "disableBodyPruning": true
              },
              "request": {
                "method": "GET",
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "url": {
                  "raw": "{{baseUrl}}/users/:id",
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "path": [
                    "users",
                    ":id"
                  ],
                  "variable": [
                    {
                      "id": "0844889b-4401-43ff-9bcc-2dda7dddf2e2",
                      "key": "id",
                      "value": "<string>",
                      "description": "(Required) The unique identifier of the user."
                    }
                  ]
                },
                "description": "Returns a single user by ID with their SaaS application details."
              },
              "response": [
                {
                  "id": "be6fef2d-d6a0-453a-86af-282f3ca10b8f",
                  "name": "User details.",
                  "originalRequest": {
                    "method": "GET",
                    "header": [
                      {
                        "key": "Accept",
                        "value": "application/json"
                      },
                      {
                        "description": "Added as a part of security scheme: apikey",
                        "key": "X-API-Key",
                        "value": "<API Key>"
                      }
                    ],
                    "url": {
                      "raw": "{{baseUrl}}/users/:id",
                      "host": [
                        "{{baseUrl}}"
                      ],
                      "path": [
                        "users",
                        ":id"
                      ],
                      "variable": [
                        {
                          "key": "id"
                        }
                      ]
                    }
                  },
                  "status": "OK",
                  "code": 200,
                  "_postman_previewlanguage": "json",
                  "header": [
                    {
                      "key": "Content-Type",
                      "value": "application/json"
                    }
                  ],
                  "cookie": [],
                  "responseTime": null,
                  "body": "{\n  \"data\": {\n    \"id\": \"<string>\",\n    \"email\": \"<email>\",\n    \"first_name\": \"<string>\",\n    \"last_name\": \"<string>\",\n    \"status\": \"deprovisioned\",\n    \"department\": \"<string>\",\n    \"title\": \"<string>\",\n    \"manager_email\": \"<email>\",\n    \"location\": \"<string>\",\n    \"created_at\": \"<dateTime>\",\n    \"updated_at\": \"<dateTime>\"\n  }\n}",
                  "createdAt": "2026-07-28T01:12:10.000Z",
                  "updatedAt": "2026-07-28T01:12:10.000Z",
                  "uid": "35240-be6fef2d-d6a0-453a-86af-282f3ca10b8f"
                },
                {
                  "id": "f0b128bf-2f8e-4161-97a2-8c2df35258df",
                  "name": "User not found.",
                  "originalRequest": {
                    "method": "GET",
                    "header": [
                      {
                        "key": "Accept",
                        "value": "application/json"
                      },
                      {
                        "description": "Added as a part of security scheme: apikey",
                        "key": "X-API-Key",
                        "value": "<API Key>"
                      }
                    ],
                    "url": {
                      "raw": "{{baseUrl}}/users/:id",
                      "host": [
                        "{{baseUrl}}"
                      ],
                      "path": [
                        "users",
                        ":id"
                      ],
                      "variable": [
                        {
                          "key": "id"
                        }
                      ]
                    }
                  },
                  "status": "Not Found",
                  "code": 404,
                  "_postman_previewlanguage": "json",
                  "header": [
                    {
                      "key": "Content-Type",
                      "value": "application/json"
                    }
                  ],
                  "cookie": [],
                  "responseTime": null,
                  "body": "{\n  \"code\": \"<string>\",\n  \"id\": \"<string>\",\n  \"href\": \"<string>\",\n  \"reason\": \"<string>\"\n}",
                  "createdAt": "2026-07-28T01:12:10.000Z",
                  "updatedAt": "2026-07-28T01:12:10.000Z",
                  "uid": "35240-f0b128bf-2f8e-4161-97a2-8c2df35258df"
                }
              ],
              "createdAt": "2026-07-28T01:12:10.000Z",
              "updatedAt": "2026-07-28T01:12:10.000Z",
              "uid": "35240-6bc2150e-1334-489a-99f7-2c6518528526"
            },
            {
              "name": "BetterCloud Update User",
              "id": "46d254c2-62e6-438d-8b74-dcbbc2dc81db",
              "protocolProfileBehavior": {
                "disableBodyPruning": true
              },
              "request": {
                "method": "PATCH",
                "header": [
                  {
                    "key": "Content-Type",
                    "value": "application/json"
                  },
                  {
                    "key": "Accept",
                    "value": "application/json"
                  }
                ],
                "body": {
                  "mode": "raw",
                  "raw": "{\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"department\": \"<string>\",\n  \"title\": \"<string>\",\n  \"location\": \"<string>\"\n}",
                  "options": {
                    "raw": {
                      "headerFamily": "json",
                      "language": "json"
                    }
                  }
                },
                "url": {
                  "raw": "{{baseUrl}}/users/:id",
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "path": [
                    "users",
                    ":id"
                  ],
                  "variable": [
                    {
                      "id": "69f6594a-8470-4a9f-ac51-4bb06245cb8c",
                      "key": "id",
                      "value": "<string>",
                      "description": "(Required) The unique identifier of the user."
                    }
                  ]
                },
                "description": "Updates user attributes across integrated SaaS applications."
              },
              "response": [
                {
                  "id": "0f269cf5-5cf3-4a8e-b51f-1e8144883f43",
                  "name": "User updated successfully.",
                  "originalRequest": {
                    "method": "PATCH",
                    "header": [
                      {
                        "key": "Content-Type",
                        "value": "application/json"
                      },
                      {
                        "key": "Accept",
                        "value": "application/json"
                      },
                      {
                        "description": "Added as a part of security scheme: apikey",
                        "key": "X-API-Key",
                        "value": "<API Key>"
                      }
                    ],
                    "body": {
                      "mode": "raw",
                      "raw": "{\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"department\": \"<string>\",\n  \"title\": \"<string>\",\n  \"location\": \"<string>\"\n}",
                      "options": {
                        "raw": {
                          "headerFamily": "json",
                          "language": "json"
                        }
                      }
                    },
                    "url": {
                      "raw": "{{baseUrl}}/users/:id",
                      "host": [
                        "{{baseUrl}}"
                      ],
                      "path": [
                        "users",
                        ":id"
                      ],
                      "variable": [
                        {
                          "key": "id"
                        }
                      ]
                    }
                  },
                  "status": "OK",
                  "code": 200,
                  "_postman_previewlanguage": "json",
                  "header": [
                    {
                      "key": "Content-Type",
                      "value": "application/json"
                    }
                  ],
                  "cookie": [],
                  "responseTime": null,
                  "body": "{\n  \"data\": {\n    \"id\": \"<string>\",\n    \"email\": \"<email>\",\n    \"first_name\": \"<string>\",\n    \"last_name\": \"<string>\",\n    \"status\": \"deprovisioned\",\n    \"department\": \"<string>\",\n    \"title\": \"<string>\",\n    \"manager_email\": \"<email>\",\n    \"location\": \"<string>\",\n    \"created_at\": \"<dateTime>\",\n    \"updated_at\": \"<dateTime>\"\n  }\n}",
                  "createdAt": "2026-07-28T01:12:10.000Z",
                  "updatedAt": "2026-07-28T01:12:10.000Z",
                  "uid": "35240-0f269cf5-5cf3-4a8e-b51f-1e8144883f43"
                }
              ],
              "createdAt": "2026-07-28T01:12:10.000Z",
              "updatedAt": "2026-07-28T01:12:10.000Z",
              "uid": "35240-46d254c2-62e6-438d-8b74-dcbbc2dc81db"
            }
          ],
          "id": "345e0666-9d0d-448b-984b-677ab930ad71",
          "createdAt": "2026-07-28T01:12:10.000Z",
          "updatedAt": "2026-07-28T01:12:10.000Z",
          "uid": "35240-345e0666-9d0d-448b-984b-677ab930ad71"
        },
        {
          "name": "BetterCloud List Users",
          "id": "d458663a-90a7-4091-8d61-ecba5a5f66b3",
          "protocolProfileBehavior": {
            "disableBodyPruning": true
          },
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Accept",
                "value": "application/json"
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/users?page=1&per_page=25&email=<email>&status=suspended",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "users"
              ],
              "query": [
                {
                  "description": "Page number for pagination.",
                  "key": "page",
                  "value": "1"
                },
                {
                  "description": "Number of results per page (max 100).",
                  "key": "per_page",
                  "value": "25"
                },
                {
                  "description": "Filter users by email address.",
                  "key": "email",
                  "value": "<email>"
                },
                {
                  "description": "Filter users by status.",
                  "key": "status",
                  "value": "suspended"
                }
              ]
            },
            "description": "Returns a paginated list of users discovered across all integrated SaaS applications."
          },
          "response": [
            {
              "id": "77326677-74f0-42da-905c-178747af32b2",
              "name": "Paginated list of users.",
              "originalRequest": {
                "method": "GET",
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  },
                  {
                    "description": "Added as a part of security scheme: apikey",
                    "key": "X-API-Key",
                    "value": "<API Key>"
                  }
                ],
                "url": {
                  "raw": "{{baseUrl}}/users?page=1&per_page=25&email=<email>&status=suspended",
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "path": [
                    "users"
                  ],
                  "query": [
                    {
                      "description": "Page number for pagination.",
                      "key": "page",
                      "value": "1"
                    },
                    {
                      "description": "Number of results per page (max 100).",
                      "key": "per_page",
                      "value": "25"
                    },
                    {
                      "description": "Filter users by email address.",
                      "key": "email",
                      "value": "<email>"
                    },
                    {
                      "description": "Filter users by status.",
                      "key": "status",
                      "value": "suspended"
                    }
                  ]
                }
              },
              "status": "OK",
              "code": 200,
              "_postman_previewlanguage": "json",
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "cookie": [],
              "responseTime": null,
              "body": "{\n  \"data\": [\n    {\n      \"id\": \"<string>\",\n      \"email\": \"<email>\",\n      \"first_name\": \"<string>\",\n      \"last_name\": \"<string>\",\n      \"status\": \"active\",\n      \"department\": \"<string>\",\n      \"title\": \"<string>\",\n      \"manager_email\": \"<email>\",\n      \"location\": \"<string>\",\n      \"created_at\": \"<dateTime>\",\n      \"updated_at\": \"<dateTime>\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"email\": \"<email>\",\n      \"first_name\": \"<string>\",\n      \"last_name\": \"<string>\",\n      \"status\": \"suspended\",\n      \"department\": \"<string>\",\n      \"title\": \"<string>\",\n      \"manager_email\": \"<email>\",\n      \"location\": \"<string>\",\n      \"created_at\": \"<dateTime>\",\n      \"updated_at\": \"<dateTime>\"\n    }\n  ],\n  \"meta\": {\n    \"page\": \"<integer>\",\n    \"per_page\": \"<integer>\",\n    \"total\": \"<integer>\"\n  }\n}",
              "createdAt": "2026-07-28T01:12:10.000Z",
              "updatedAt": "2026-07-28T01:12:10.000Z",
              "uid": "35240-77326677-74f0-42da-905c-178747af32b2"
            },
            {
              "id": "1b3d9752-95bd-443c-8911-6e70350a409e",
              "name": "Unauthorized.",
              "originalRequest": {
                "method": "GET",
                "header": [
                  {
                    "key": "Accept",
                    "value": "application/json"
                  },
                  {
                    "description": "Added as a part of security scheme: apikey",
                    "key": "X-API-Key",
                    "value": "<API Key>"
                  }
                ],
                "url": {
                  "raw": "{{baseUrl}}/users?page=1&per_page=25&email=<email>&status=suspended",
                  "host": [
                    "{{baseUrl}}"
                  ],
                  "path": [
                    "users"
                  ],
                  "query": [
                    {
                      "description": "Page number for pagination.",
                      "key": "page",
                      "value": "1"
                    },
                    {
                      "description": "Number of results per page (max 100).",
                      "key": "per_page",
                      "value": "25"
                    },
                    {
                      "description": "Filter users by email address.",
                      "key": "email",
                      "value": "<email>"
                    },
                    {
                      "description": "Filter users by status.",
                      "key": "status",
                      "value": "suspended"
                    }
                  ]
                }
              },
              "status": "Unauthorized",
              "code": 401,
              "_postman_previewlanguage": "json",
              "header": [
                {
                  "key": "Content-Type",
                  "value": "application/json"
                }
              ],
              "cookie": [],
              "responseTime": null,
              "body": "{\n  \"code\": \"<string>\",\n  \"id\": \"<string>\",\n  \"href\": \"<string>\",\n  \"reason\": \"<string>\"\n}",
              "createdAt": "2026-07-28T01:12:10.000Z",
              "updatedAt": "2026-07-28T01:12:10.000Z",
              "uid": "35240-1b3d9752-95bd-443c-8911-6e70350a409e"
            }
          ],
          "createdAt": "2026-07-28T01:12:10.000Z",
          "updatedAt": "2026-07-28T01:12:10.000Z",
          "uid": "35240-d458663a-90a7-4091-8d61-ecba5a5f66b3"
        }
      ],
      "id": "4afc1f9d-0dbc-417e-bf1c-33ca2f6982a8",
      "createdAt": "2026-07-28T01:12:10.000Z",
      "updatedAt": "2026-07-28T01:12:10.000Z",
      "uid": "35240-4afc1f9d-0dbc-417e-bf1c-33ca2f6982a8"
    }
  ],
  "auth": {
    "type": "apikey",
    "apikey": [
      {
        "key": "key",
        "value": "X-API-Key",
        "type": "string"
      },
      {
        "key": "value",
        "value": "{{apiKey}}",
        "type": "string"
      },
      {
        "key": "in",
        "value": "header",
        "type": "string"
      }
    ]
  },
  "variable": [
    {
      "key": "baseUrl",
      "value": "https://api.bettercloud.com/v1"
    }
  ]
}