Get Organization User

GET

/v1/organization_users/{userId}

The Get Organization User API retrieves detailed information about a specific user within an organization, identified by userId. This API provides insights into the user’s role and other relevant details within the organization, allowing for effective management and oversight of user accounts within the organizational structure.

Request

Authorization

Add parameter in header

X-Jicoo-Api-Key

Example:

X-Jicoo-Api-Key: ********************

Path Params

userId

string

required

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

data

object (OrganizationUser)

required

userId

string

required

Unique ID of the user

name

string

required

Name of the user

profileImage

string | null

required

Profile image URL of the user

required

Email of the user

color

string

required

Color preference of the user

slug

string

required

Slug for the user profile

role

enum<string>

required

Role of the user in the organization

Allowed values:

owneradminmemberrestricted

createdAt

string <date-time>

required

Creation time of the user profile

updatedAt

string <date-time>

required

Last update time of the user profile

Example

{
  "data": {
    "userId": "string",
    "name": "string",
    "profileImage": "string",
    "email": "user@example.com",
    "color": "string",
    "slug": "string",
    "role": "owner",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

🟠404Record Not Found

Modified at 2024-08-28 09:49:49

Delete Organization User

Update Organization User