Users

A standard representation of users who uses and operates WorkDrive.

Download Users OpenAPI Document
Download






Get User Info

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

This API fetches information about the user. Returns user pieces of information like name, email, zohouserid(Zuid), and WorkDrive edition currently the user is on.

Endpoints

OAuth Scope

WorkDrive.users.READCopied!

Request Example

cURL
cURL
Deluge
Copied!
curl --request GET \
  --url https://www.zohoapis.com/workdrive/api/v1/users/me \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'

Response Example

U001

R008

F000

200
200
400
401
500
Copied!
  {
    "data": {
      "id": "747938014",
      "type": "users",
      "attributes": {
        "email_id": "zylker@zylker.com",
        "member_type": 1,
        "theme_color": "28B294",
        "getting_started": 1,
        "is_org_template_admin": true,
        "favoritedfiles_view_pref": {
          "sort_by": "last_modified",
          "sort_order": "desc",
          "filtered_by": "all",
          "layout": "list"
        },
        "default_view_type": 2,
        "view_pref": {
          "sort_by": "last_modified",
          "sort_order": "desc",
          "layout": "list"
        },
        "edition": "TEAM",
        "unread_count_myspace": 0,
        "storage_info": {
          "size": "181.0 KB",
          "storage_used": "256.0 KB",
          "files_count": 2,
          "folders_count": 1,
          "size_in_bytes": 185368,
          "storage_used_in_bytes": 262225
        },
        "mig_status": 0,
        "last_login_time_in_millisecond": 0,
        "files_view_pref": {
          "sort_by": "last_modified",
          "sort_order": "desc",
          "filtered_by": "all",
          "layout": "list"
        },
        "invited_time": 1618243925174,
        "user_type": 1,
        "labeledfiles_view_pref": {
          "sort_by": "last_modified",
          "sort_order": "desc",
          "filtered_by": "all",
          "layout": "list"
        },
        "zid": "747938014",
        "role_id": 32,
        "preferred_view": "TEAM",
        "is_sync_enabled": true,
        "has_myfolder": true,
        "last_accessed_library": "",
        "is_mobile_enabled": true,
        "last_accessed_folder": "",
        "enable_myspace_restriction_all": false,
        "connected_devices": 0,
        "outgoingfiles_view_pref": {
          "sort_by": "last_modified",
          "sort_order": "desc",
          "filtered_by": "all",
          "layout": "list"
        },
        "capabilities": {
          "can_access_myfolder": true,
          "can_have_org_templates": true,
          "can_sync": true,
          "can_create_team": false
        },
        "incomingfiles_view_pref": {
          "sort_by": "shared_time",
          "sort_order": "desc",
          "filtered_by": "all",
          "layout": "list"
        },
        "app_names": [],
        "is_personal_exist": false,
        "preferred_team_id": "ly9zmae16b43c258f458a9a57ac02c4f8d763",
        "display_name": "Zylker Creation",
        "zuid": "747938014",
        "trashedfiles_view_pref": {
          "sort_by": "last_modified",
          "sort_order": "desc",
          "filtered_by": "all",
          "layout": "list"
        },
        "avatar_url": "https://contacts.zoho.com/file?t=user&ID=747938014&fs=thumb&nps=404",
        "allowed_myspace_storage": -1,
        "org_id": "ly9zmae16b43c258f458a9a57ac02c4f8d763",
        "is_unread_myspace": false,
        "invited_time_i18": "Apr 12, 9:42 PM",
        "zid_type": 262144,
        "status": "ACTIVE"
      },
      "relationships": {
        "privatespace": {
          "links": {
            "self": "https://www.zohoapis.com/workdrive/users/747938014/relationships/privatespace",
            "related": "https://www.zohoapis.com/workdrive/users/747938014/privatespace"
          }
        },
        "teams": {
          "links": {
            "self": "https://www.zohoapis.com/workdrive/users/747938014/relationships/teams",
            "related": "https://www.zohoapis.com/workdrive/users/747938014/teams"
          }
        },
        "devices": {
          "links": {
            "self": "https://www.zohoapis.com/workdrive/users/747938014/relationships/devices",
            "related": "https://www.zohoapis.com/workdrive/users/747938014/devices"
          }
        },
        "records": {
          "links": {
            "self": "https://www.zohoapis.com/workdrive/users/747938014/relationships/records",
            "related": "https://www.zohoapis.com/workdrive/users/747938014/records"
          }
        },
        "enterprise": {
          "links": {
            "self": "https://www.zohoapis.com/workdrive/users/747938014/relationships/enterprise",
            "related": "https://www.zohoapis.com/workdrive/users/747938014/enterprise"
          }
        },
        "incomingfiles": {
          "links": {
            "self": "https://www.zohoapis.com/workdrive/users/747938014/relationships/incomingfiles",
            "related": "https://www.zohoapis.com/workdrive/users/747938014/incomingfiles"
          }
        },
        "libraries": {
          "links": {
            "self": "https://www.zohoapis.com/workdrive/users/747938014/relationships/libraries",
            "related": "https://www.zohoapis.com/workdrive/users/747938014/libraries"
          }
        },
        "favoritedfiles": {
          "links": {
            "self": "https://www.zohoapis.com/workdrive/users/747938014/relationships/favoritedfiles",
            "related": "https://www.zohoapis.com/workdrive/users/747938014/favoritedfiles"
          }
        },
        "groups": {
          "links": {
            "self": "https://www.zohoapis.com/workdrive/users/747938014/relationships/groups",
            "related": "https://www.zohoapis.com/workdrive/users/747938014/groups"
          }
        },
        "labels": {
          "links": {
            "self": "https://www.zohoapis.com/workdrive/users/747938014/relationships/labels",
            "related": "https://www.zohoapis.com/workdrive/users/747938014/labels"
          }
        },
        "recentfiles": {
          "links": {
            "self": "https://www.zohoapis.com/workdrive/users/747938014/relationships/recentfiles",
            "related": "https://www.zohoapis.com/workdrive/users/747938014/recentfiles"
          }
        },
        "license": {
          "links": {
            "self": "https://www.zohoapis.com/workdrive/users/747938014/relationships/license",
            "related": "https://www.zohoapis.com/workdrive/users/747938014/license"
          }
        },
        "recordsuggestions": {
          "links": {
            "self": "https://www.zohoapis.com/workdrive/users/747938014/relationships/recordsuggestions",
            "related": "https://www.zohoapis.com/workdrive/users/747938014/recordsuggestions"
          }
        },
        "organization": {
          "links": {
            "self": "https://www.zohoapis.com/workdrive/users/747938014/relationships/organization",
            "related": "https://www.zohoapis.com/workdrive/users/747938014/organization"
          }
        },
        "collaborators": {
          "links": {
            "self": "https://www.zohoapis.com/workdrive/users/747938014/relationships/collaborators",
            "related": "https://www.zohoapis.com/workdrive/users/747938014/collaborators"
          }
        },
        "labeledfiles": {
          "links": {
            "self": "https://www.zohoapis.com/workdrive/users/747938014/relationships/labeledfiles",
            "related": "https://www.zohoapis.com/workdrive/users/747938014/labeledfiles"
          }
        },
        "incomingfolders": {
          "links": {
            "self": "https://www.zohoapis.com/workdrive/users/747938014/relationships/incomingfolders",
            "related": "https://www.zohoapis.com/workdrive/users/747938014/incomingfolders"
          }
        },
        "workspaces": {
          "links": {
            "self": "https://www.zohoapis.com/workdrive/users/747938014/relationships/workspaces",
            "related": "https://www.zohoapis.com/workdrive/users/747938014/workspaces"
          }
        },
        "unreadfiles": {
          "links": {
            "self": "https://www.zohoapis.com/workdrive/users/747938014/relationships/unreadfiles",
            "related": "https://www.zohoapis.com/workdrive/users/747938014/unreadfiles"
          }
        },
        "tasks": {
          "links": {
            "self": "https://www.zohoapis.com/workdrive/users/747938014/relationships/tasks",
            "related": "https://www.zohoapis.com/workdrive/users/747938014/tasks"
          }
        },
        "notifications": {
          "links": {
            "self": "https://www.zohoapis.com/workdrive/users/747938014/relationships/notifications",
            "related": "https://www.zohoapis.com/workdrive/users/747938014/notifications"
          }
        },
        "contacts": {
          "links": {
            "self": "https://www.zohoapis.com/workdrive/users/747938014/relationships/contacts",
            "related": "https://www.zohoapis.com/workdrive/users/747938014/contacts"
          }
        },
        "apps": {
          "links": {
            "self": "https://www.zohoapis.com/workdrive/users/747938014/relationships/apps",
            "related": "https://www.zohoapis.com/workdrive/users/747938014/apps"
          }
        }
      },
      "links": {
        "self": "https://www.zohoapis.com/workdrive/users/747938014"
      }
    }
  }
                
  {
    "errors": [
      {
        "id": "U001",
        "title": "Invalid or missing OAuth token"
      }
    ]
  }
                
  {
    "errors": [
      {
        "id": "R008",
        "title": "Authentication required"
      }
    ]
  }
                
  {
    "errors": [
      {
        "id": "F000",
        "title": "Unexpected server error"
      }
    ]
  }
                
Show full