{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Me API V3","description":"Sprinklr offers robust, convenient, and simple RESTful Web service APIs to integrate data from Sprinklr to any external system.","keywords":["Sprinklr API","Sprinklr Developer Portal","OAuth 2.0","RESTful API","Social Media API","Customer Experience API","Unified-CXM","Social Listening API"]},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"me-api-v3","__idx":0},"children":["Me API V3"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Me API"]}," to retrieve details about the currently authenticated Sprinklr user. Developers can use this endpoint to identify the user associated with an access token and retrieve user, customer, and workspace information."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The endpoint requires no request parameters or request body. Authentication determines which user's information is returned."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"overview","__idx":1},"children":["Overview"]},{"$$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":"Operation"},"children":["Operation"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Path"},"children":["Path"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fetch current user"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/me"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["There is no request body, no query parameter, and no path parameter. ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["The access token itself is the input."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The operation is part of User API V3, which also provides operations for retrieving and managing other users."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"base-url","__idx":2},"children":["Base URL"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"https://api3.sprinklr.com/{env}/api/v3/me\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Replace {env} with your assigned Sprinklr environment. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dev.sprinklr.com/apis"},"children":["APIs | Sprinklr Developer Portal"]}," for the published environment list."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For the production environment at app.sprinklr.com, omit the {env} segment from the URL."]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Credentials are environment-scoped."]}," An API key and token generated for one environment return ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401"]}," against another, even when the request is otherwise perfect. Because ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/me"]}," is the endpoint you will use to ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["test"]}," credentials, this is worth stating plainly: a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401"]}," from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/me"]}," very often means \"right credentials, wrong environment\" rather than \"bad credentials.\""]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"authentication","__idx":3},"children":["Authentication"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Me API V3 requires bearer-token and API-key authentication. The V3 API reference specifies both bearerAuth and apiKeyAuth for this operation. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dev.sprinklr.com/api-overview"},"children":["API Overview"]}," for portal registration, API key and secret generation, and the Authorization flow."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Include the following headers:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This is a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," with no request body, so there is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["no ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Content-Type"]}," header"]},"."]},{"$$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":"Header"},"children":["Header"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value"},"children":["Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Purpose"},"children":["Purpose"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Bearer {{accessToken}}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Credential used by the API to authenticate a user with the server"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Key"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{{apiKey}}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["API key that authenticates the application with the server. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dev.sprinklr.com/api-key-and-secret-generation"},"children":["API Key and Secret Generation"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Accept"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/json"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Determines the acceptable response type from the server"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A Content-Type header is not required because the GET request does not contain a request body."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"fetch-the-current-user","__idx":4},"children":["Fetch the current user"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the following operation to retrieve information about the authenticated user:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /api/v3/me\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The operation does not require query parameters, path parameters, or a request body."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-request","__idx":5},"children":["Example request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X GET \\\n  'https://api3.sprinklr.com/{env}/api/v3/me' \\\n  -H 'Authorization: Bearer {{accessToken}}' \\\n  -H 'Key: {{apiKey}}' \\\n  -H 'Accept: application/json'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"response","__idx":6},"children":["Response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response provides information about the authenticated user, including the user's identifier, name, email address, user type, customer, workspace, and configured properties."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["V3 returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," as an array containing the user object:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": [\n    {\n      \"id\": 60000000,\n      \"type\": \"PARTNER_ADMIN\",\n      \"name\": \"Jane Doe\",\n      \"email\": \"jane.doe@example.com\",\n      \"properties\": {\n        \"spr_user_availability_status\": [\"Connection Issue\"],\n        \"support_access\": [\"true\"],\n        \"_c_00000000000000000000000a\": [\"Morning Shift\"]\n      },\n      \"customerId\": 60000000,\n      \"workspaceId\": 60000002\n    }\n  ],\n  \"errors\": []\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["properties"]}," map is abridged here. A real response contains many more entries."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response-fields","__idx":7},"children":["Response fields"]},{"$$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":"Field"},"children":["Field"]},{"$$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":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Numeric user ID of the authenticated user"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["User type — see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#the-type-field"},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," field"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Display name of the user"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["email"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Email address of the user"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["properties"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Map of custom-field keys to arrays of string values — see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#the-properties-map"},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["properties"]}," map"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["customerId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifier of the customer/partner the user belongs to"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["workspaceId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifier of the user's workspace"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sibling of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]},". Empty on success"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These fields are also represented in Sprinklr's authenticated-user example."]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The structure returned by /me differs from the broader /user resource. GET /api/v3/user returns the richer user schema used to retrieve another user by ID or email."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"status-codes","__idx":8},"children":["Status codes"]},{"$$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 status"},"children":["HTTP status"]},{"$$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":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authenticated user returned"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400 Bad Request"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Malformed request. Unusual here — there is nothing to malform but headers"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401 Unauthorized"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invalid, missing, or expired ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}," token or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Key"]}," header, or credentials from a different environment"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403 Forbidden"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Credentials valid but not permitted"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404 Not Found"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Wrong path or wrong ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{env}"]}," segment"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"the-error-object","__idx":9},"children":["The error object"]},{"$$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":"Field"},"children":["Field"]},{"$$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":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Error identifier"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["code"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Numeric error code"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["message"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Error key, for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["account.not.found"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Error responses return ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["null"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"migrating-from-v2","__idx":10},"children":["Migrating from V2"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To migrate from Me API V2 to V3, update the version in the endpoint:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"For V2, - GET https://api3.sprinklr.com/{env}/api/v2/me\nFor V3, + GET https://api3.sprinklr.com/{env}/api/v3/me\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"common-use-cases","__idx":11},"children":["Common Use Cases"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"verify-credentials-before-anything-else","__idx":12},"children":["Verify credentials before anything else"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -s -o /dev/null -w '%{http_code}\\n' \\\n  'https://api3.sprinklr.com/{env}/api/v3/me' \\\n  -H 'Authorization: Bearer {{accessToken}}' \\\n  -H 'Key: {{apiKey}}' \\\n  -H 'Accept: application/json'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," means the token, the API key, and the environment all agree. Anything else means the problem is your credentials, not the endpoint you were originally calling."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"discover-the-workspace-at-startup","__idx":13},"children":["Discover the workspace at startup"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"python","header":{"controls":{"copy":{}}},"source":"me = current_user(requests.get(url, headers=headers).json())\nWORKSPACE_ID = me[\"workspaceId\"]\nCUSTOMER_ID  = me[\"customerId\"]\nUSER_ID      = me[\"id\"]\n","lang":"python"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Cache these for the process lifetime rather than calling ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/me"]}," per request."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"gate-administrative-features-on-user-type","__idx":14},"children":["Gate administrative features on user type"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"python","header":{"controls":{"copy":{}}},"source":"if me[\"type\"] in (\"PARTNER_ADMIN\", \"CLIENT_ADMIN\"):\n    enable_admin_features()\nelse:\n    enable_standard_features()   # default branch handles unknown types\n","lang":"python"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"read-a-custom-property-safely","__idx":15},"children":["Read a custom property safely"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"python","header":{"controls":{"copy":{}}},"source":"def prop(me, key, default=None):\n    values = me.get(\"properties\", {}).get(key)\n    if not values:\n        return default\n    return values[0]              # always an array of strings\n\nstatus = prop(me, \"spr_user_availability_status\")\n","lang":"python"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related","__idx":16},"children":["Related"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/me-api"},"children":["Me Api (V2)"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/user-apis"},"children":["User APIs"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/scim-user-apis"},"children":["SCIM (User) APIs"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/read-user"},"children":["Read User"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/api-overview"},"children":["API Overview"]}]}]}]},"headings":[{"value":"Me API V3","id":"me-api-v3","depth":1},{"value":"Overview","id":"overview","depth":2},{"value":"Base URL","id":"base-url","depth":2},{"value":"Authentication","id":"authentication","depth":2},{"value":"Fetch the current user","id":"fetch-the-current-user","depth":2},{"value":"Example request","id":"example-request","depth":3},{"value":"Response","id":"response","depth":2},{"value":"Response fields","id":"response-fields","depth":3},{"value":"Status codes","id":"status-codes","depth":2},{"value":"The error object","id":"the-error-object","depth":3},{"value":"Migrating from V2","id":"migrating-from-v2","depth":2},{"value":"Common Use Cases","id":"common-use-cases","depth":2},{"value":"Verify credentials before anything else","id":"verify-credentials-before-anything-else","depth":3},{"value":"Discover the workspace at startup","id":"discover-the-workspace-at-startup","depth":3},{"value":"Gate administrative features on user type","id":"gate-administrative-features-on-user-type","depth":3},{"value":"Read a custom property safely","id":"read-a-custom-property-safely","depth":3},{"value":"Related","id":"related","depth":2}],"frontmatter":{"seo":{"title":"Me API V3"}},"lastModified":"2026-11-06T09:35:17.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/developer-guides-v3/me-api-v3","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}