{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Treasure Data User API","description":"Treasure Data Product Documentation · Collect and Unify · Segment and Activate · Experiment and Analyze · Decisioning Automate with AI Scale and Trust.","siteUrl":"https://docs.treasuredata.com","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"treasure-data-user-api","__idx":0},"children":["Treasure Data User API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This allows you to control user-related actions via the API."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"get-userlist","__idx":1},"children":["GET /user/list"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This operation gets a list of users."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"HTTP Verb"},"children":["HTTP Verb"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Resource"},"children":["Resource"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v3/user/list/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["get the list of users"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sample Response Status: 200 OK"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"[\n  {\n    \"id\": 123,\n    \"account_owner\": true,\n    \"administrator\": true,\n    \"created_at\": \"2020-12-31T11:22:33.000Z\",\n    \"email\": \"jake@companyName.com\",\n    \"first_name\": \"Jake\",\n    \"gravatar_url\": \"http://foo\",\n    \"identifier\": \"employee_number-00001\",\n    \"last_name\": \"Becker\",\n    \"name\": \"Jake Becker\",\n    \"organization\": \"string\",\n    \"phone\": \"(650) 469-3644\",\n    \"roles\": [\n      \"string\"\n    ],\n    \"updated_at\": \"2020-12-31T11:22:33.000Z\"\n  }\n]\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"get-usershow","__idx":2},"children":["GET /user/show"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This operation shows the current user’s information."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"HTTP Verb"},"children":["HTTP Verb"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Resource"},"children":["Resource"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v3/user/show"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["show current user"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sample Response Status: 200 OK"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"id\": 123,\n  \"account_owner\": true,\n  \"administrator\": true,\n  \"created_at\": \"2020-12-31T11:22:33.000Z\",\n  \"email\": \"jake@companyName.com\",\n  \"first_name\": \"Jake\",\n  \"gravatar_url\": \"http://foo\",\n  \"identifier\": \"employee_number-00001\",\n  \"last_name\": \"Becker\",\n  \"name\": \"Jake Becker\",\n  \"organization\": \"string\",\n  \"phone\": \"(650) 469-3644\",\n  \"roles\": [\n    \"string\"\n  ],\n  \"updated_at\": \"2020-12-31T11:22:33.000Z\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"post-v3userremoveuser_email","__idx":3},"children":["POST /v3/user/remove/:user_email"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This operation deletes a user by email."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"HTTP Verb"},"children":["HTTP Verb"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Resource"},"children":["Resource"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v3/user/remove/:user_email"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["delete specified user with email"]}]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter Name"},"children":["Parameter Name"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["user_email"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Yes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The email user uses to log in to Treasure Console. For example, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["jake@companyName.com"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","data-title":"Sample Request","header":{"title":"Sample Request","controls":{"copy":{}}},"source":"curl --location --request POST \\\n'https://api.treasuredata.com/v3/user/remove/jake@companyName.com' \\\n--header 'Accept: application/json' \\\n--header 'Authorization: TD1 123/abcdef•••••••••••••••••••••••0123456789'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","data-title":"Sample Response Status: 200 OK","header":{"title":"Sample Response Status: 200 OK","controls":{"copy":{}}},"source":"{\n  \"user\": \"jake@companyName.com\"\n}\n","lang":"json"},"children":[]}]},"headings":[{"value":"Treasure Data User API","id":"treasure-data-user-api","depth":1},{"value":"GET /user/list","id":"get-userlist","depth":2},{"value":"GET /user/show","id":"get-usershow","depth":2},{"value":"POST /v3/user/remove/:user_email","id":"post-v3userremoveuser_email","depth":2}],"frontmatter":{"seo":{"title":"Treasure Data User API"}},"lastModified":"2026-06-01T09:09:59.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/apis/td-api/user-api","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}