Users - Calven

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200OK

application/json

Body

array of:

email

object

required

The email address of the user

Example:

johndoe@calven.com

firstName

object

required

The first name of the user

Example:

John

lastName

object

required

The last name of the user

Example:

Doe

onboarded

boolean

required

Whether the user has completed onboarding

Example:

true

primaryGroupId

object

required

The primary group id of the user

Example:

3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b

primaryLocationId

object

required

The primary location id of the user

Example:

3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b

status

string

required

The status of the user

Example:

active

userId

string

required

The id of the user

Example:

3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b

userName

string

required

The username of the user

Example:

johndoe@calven.com

Example

[
  {
    "email": "johndoe@calven.com",
    "firstName": "John",
    "lastName": "Doe",
    "onboarded": true,
    "primaryGroupId": "3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b",
    "primaryLocationId": "3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b",
    "status": "active",
    "userId": "3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b",
    "userName": "johndoe@calven.com"
  }
]