{
  "opencollection": "1.0.0",
  "info": {
    "name": "MX Platform accounts users API",
    "version": "20111101"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "users",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List users",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://int-api.mx.com/users",
            "params": [
              {
                "name": "page",
                "value": "1",
                "type": "query",
                "description": "Results are paginated. Specify current page."
              },
              {
                "name": "records_per_page",
                "value": "10",
                "type": "query",
                "description": "This specifies the number of records to be returned on each page. Defaults to `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead."
              },
              {
                "name": "id",
                "value": "u-12324-abdc",
                "type": "query",
                "description": "The user `id` to search for."
              },
              {
                "name": "email",
                "value": "example@example.com",
                "type": "query",
                "description": "The user `email` to search for."
              },
              {
                "name": "is_disabled",
                "value": "true",
                "type": "query",
                "description": "Search for users that are diabled."
              }
            ]
          },
          "docs": "Use this endpoint to list every user you've created in the MX Platform API."
        },
        {
          "info": {
            "name": "Create user",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://int-api.mx.com/users",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Use this endpoint to create a new user. The API will respond with the newly-created user object if successful, containing a `guid` that you'll set as the `user_guid` in other requests when required. Disabling a user means that accounts and transactions associated with it will not be updated in the background by MX. It will also restrict access to that user’s data until they are no longer disabled."
        },
        {
          "info": {
            "name": "Read user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://int-api.mx.com/users/:user_guid",
            "params": [
              {
                "name": "user_guid",
                "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
                "type": "path",
                "description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
              }
            ]
          },
          "docs": "Use this endpoint to read the attributes of a specific user."
        },
        {
          "info": {
            "name": "Update user",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://int-api.mx.com/users/:user_guid",
            "params": [
              {
                "name": "user_guid",
                "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
                "type": "path",
                "description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Use this endpoint to update the attributes of the specified user."
        },
        {
          "info": {
            "name": "Delete user",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://int-api.mx.com/users/:user_guid",
            "headers": [
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "user_guid",
                "value": "USR-fa7537f3-48aa-a683-a02a-b18940482f54",
                "type": "path",
                "description": "The unique identifier for a `user`, beginning with the prefix `USR-`."
              }
            ]
          },
          "docs": "Use this endpoint to delete the specified `user`. The response will have a status of `204 No Content` without an object.\n\n:::warning\nDeleting a user is permanent. Deleted users can never be restored. For more info, see [Deleting Objects](/api-reference/platform-api/overview/deleting-objects).\n:::\n"
        },
        {
          "info": {
            "name": "Read user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://int-api.mx.com/users/:user_identifier",
            "headers": [
              {
                "name": "Accept-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "user_identifier",
                "value": "",
                "type": "path",
                "description": "Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](https://docs.mx.com/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)."
              }
            ]
          },
          "docs": "Use this endpoint to read the attributes of a specific user."
        },
        {
          "info": {
            "name": "Update user",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://int-api.mx.com/users/:user_identifier",
            "headers": [
              {
                "name": "Accept-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "user_identifier",
                "value": "",
                "type": "path",
                "description": "Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](https://docs.mx.com/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Use this endpoint to update the attributes of the specified user."
        },
        {
          "info": {
            "name": "Delete user",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://int-api.mx.com/users/:user_identifier",
            "headers": [
              {
                "name": "Accept-Version",
                "value": ""
              },
              {
                "name": "Accept",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "user_identifier",
                "value": "",
                "type": "path",
                "description": "Use either the user `id` you defined or the MX-defined user `guid`. See [MX-Defined GUIDs vs IDs Defined by You​](https://docs.mx.com/products/connectivity/overview/held-data/#mx-defined-guids-vs-ids-defined-by-you)."
              }
            ]
          },
          "docs": "Use this endpoint to delete the specified `user`. The response will have a status of `204 No Content` without an object.\n\n:::warning\nDeleting a user is permanent. Deleted users can never be restored. For more info, see [Deleting Objects](https://docs.mx.com/api-reference/platform-api/overview/deleting-objects).\n:::\n"
        }
      ]
    }
  ],
  "bundled": true
}