Skip to main content
GET
/
api
/
v2
/
users
/
{userId}
Get user
curl --request GET \
  --url https://api.example.com/api/v2/users/{userId}
{
  "data": {
    "id": "<string>",
    "displayName": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "profilePictureUrl": "<string>",
    "email": "<string>",
    "username": "<string>",
    "appRole": "DefaultAccess",
    "addedOn": "2023-11-07T05:31:56Z",
    "hasLoggedIn": true,
    "isServiceAccount": true,
    "isAgentUser": true,
    "organizationRole": "Admin",
    "workspaceRole": "Owner",
    "groups": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "accountName": "<string>",
        "creationDate": "2023-11-07T05:31:56Z",
        "lastModificationDate": "2023-11-07T05:31:56Z",
        "groupOwner": "<string>",
        "name": "<string>",
        "description": "<string>",
        "members": "<array>",
        "role": "Owner",
        "workspacesAssigned": [
          "<string>"
        ]
      }
    ],
    "roleAssignments": [
      {
        "userId": "<string>",
        "workspaceId": "<string>",
        "workspaceName": "<string>",
        "assignmentType": "<string>",
        "role": "Owner"
      }
    ]
  },
  "meta": {
    "requestId": "<string>",
    "timestamp": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.contraforce.com/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

userId
string
required

Response

OK

Standard v2 API response envelope for single-item responses.

data
object

Represents an employee or a user in ContraForce client's tenant and it's built on top of the Microsoft Graph user model and could be extended based on other provider needs

meta
object