Get Customer User By ID

curl --request GET \
  --url https://api.joinworth.com/auth/api/v1/customers/{customerID}/users/{userID} \
  --header 'Authorization: Bearer <token>'

{
  "status": "success",
  "message": "Success",
  "data": {
    "id": "94520740-d63c-4e02-85ca-c4e138801e73",
    "first_name": "Sandbox",
    "last_name": "CRO",
    "email": "[email protected]",
    "mobile": null,
    "is_email_verified": false,
    "is_first_login": true,
    "created_at": "2024-02-12T14:16:49.053328",
    "created_by": "b03d6f6a-063b-4e71-8195-9f6f590a6257",
    "updated_at": "2024-02-12T14:16:49.053328",
    "updated_by": "b03d6f6a-063b-4e71-8195-9f6f590a6257",
    "status": "ACTIVE",
    "company_details": {
      "id": "2e6438cb-ec3f-4e94-b5c9-8c058d2efaf1",
      "name": "Sandbox",
      "contact_number": null,
      "is_active": true,
      "created_at": "2024-02-12T09:26:48.247698",
      "created_by": "9e18e65b-8ab5-48fd-87ad-3b586146a00f",
      "updated_at": "2024-02-12T09:26:48.247698",
      "updated_by": "9e18e65b-8ab5-48fd-87ad-3b586146a00f"
    },
    "subrole": {
      "id": "f1fa445c-743b-4a0e-ad54-bb9294c41005",
      "code": "cro",
      "label": "CRO",
      "role_id": 2,
      "display_name": "CRO"
    }
  }
}

GET

customers

{customerID}

users

{userID}

Get Customer User By ID

curl --request GET \
  --url https://api.joinworth.com/auth/api/v1/customers/{customerID}/users/{userID} \
  --header 'Authorization: Bearer <token>'

{
  "status": "success",
  "message": "Success",
  "data": {
    "id": "94520740-d63c-4e02-85ca-c4e138801e73",
    "first_name": "Sandbox",
    "last_name": "CRO",
    "email": "[email protected]",
    "mobile": null,
    "is_email_verified": false,
    "is_first_login": true,
    "created_at": "2024-02-12T14:16:49.053328",
    "created_by": "b03d6f6a-063b-4e71-8195-9f6f590a6257",
    "updated_at": "2024-02-12T14:16:49.053328",
    "updated_by": "b03d6f6a-063b-4e71-8195-9f6f590a6257",
    "status": "ACTIVE",
    "company_details": {
      "id": "2e6438cb-ec3f-4e94-b5c9-8c058d2efaf1",
      "name": "Sandbox",
      "contact_number": null,
      "is_active": true,
      "created_at": "2024-02-12T09:26:48.247698",
      "created_by": "9e18e65b-8ab5-48fd-87ad-3b586146a00f",
      "updated_at": "2024-02-12T09:26:48.247698",
      "updated_by": "9e18e65b-8ab5-48fd-87ad-3b586146a00f"
    },
    "subrole": {
      "id": "f1fa445c-743b-4a0e-ad54-bb9294c41005",
      "code": "cro",
      "label": "CRO",
      "role_id": 2,
      "display_name": "CRO"
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

customerID

string<uuid>

required

userID

string<uuid>

required

Response

status

string

message

string

data

object

Show child attributes

data.id

string<uuid>

Unique identifier for the user

Example:

"94520740-d63c-4e02-85ca-c4e138801e73"

data.first_name

string

First name of the user

data.last_name

string

Last name of the user

data.email

string<email>

Email address of the user

data.mobile

string | null

Mobile phone number of the user, if provided

data.is_email_verified

boolean

Whether the email address of the user has been verified

True if the user has not yet completed their first login flow

data.created_at

string<date-time>

Timestamp when the user was created

data.created_by

string<uuid>

ID of the actor who created this user

data.updated_at

string<date-time>

Timestamp of the last update to this user

data.updated_by

string<uuid>

ID of the actor who last updated this user

data.status

enum<string>

Active/Inactive state of user

Available options:

ACTIVE,

INACTIVE

data.company_details

object

The company record of the customer associated with this user

Show child attributes

data.company_details.id

string<uuid>

Unique identifier for the company

data.company_details.name

string

Company name

data.company_details.contact_number

string | null

Company contact phone, if available

data.company_details.is_active

boolean

Whether the company account is active

data.company_details.created_at

string<date-time>

Timestamp when the company was created

data.company_details.created_by

string<uuid>

ID of who created the company record

data.company_details.updated_at

string<date-time>

Timestamp of last company record update

data.company_details.updated_by

string<uuid>

ID of who last updated the company record

data.subrole

object

The assigned subrole of the user

Show child attributes

data.subrole.id

string<uuid>

Subrole identifier

data.subrole.code

string

Machine-readable code for the subrole

data.subrole.label

string

Human-readable label for the subrole

data.subrole.role_id

integer

Numeric ID of the parent role

data.subrole.display_name

string

Display name for the subrole

Create Customer User Update Customer User By ID

⌘I

Sign In

Forgot Password

Customers

Customer Users

Business

Cases

Business Details

Worth 360 Report

NPI

Custom Fields

Get Customer User By ID

Authorizations

Path Parameters

Response