Verso Sandbox API

Users

Endpointhttps://api.versohq.dev

Manage users who operate payroll

List users for your tenant

GET

https://api.versohq.dev

/users

Retrieves all users associated with your tenant (automatically determined from your API Key).

List users for your tenant › query Parameters

filter

string

The OData filter expression (with support for attribute fields)

orderBy

string

The OData order-by expression (with support for attribute fields)

result

string · enum

The query result type: items, count or items with count (default: result items)

The query result type

Enum values:

Items

Count

ItemsWithCount

select

string

The OData field selection expression

skip

integer · int64

The number of items in the queried collection that are to be skipped

status

string · enum

The object status (default: all status)

The object status

Enum values:

Active

Inactive

top

integer · int64

The number of items in the queried collection

List users for your tenant › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

List users for your tenant › Responses

object[]

id

integer · int32

Unique identifier

identifier

string

firstName

string

lastName

string

culture

string

userType

string

status

string · enum

The object status

Enum values:

Active

Inactive

GET/users

curl --request GET \
  --url https://api.versohq.dev/users \
  --header 'Authorization: <string>'

shell

Example Responses

[
  {
    "id": 0,
    "identifier": "identifier",
    "firstName": "firstName",
    "lastName": "lastName",
    "culture": "culture",
    "userType": "userType",
    "status": "Active"
  }
]

json

application/json

Create a new user

POST

https://api.versohq.dev

/users

Creates a new user for your tenant.

Create a new user › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Create a new user › Request Body

identifier

string · required

Unique identifier for the user (typically email)

firstName

string

User's first name

lastName

string

User's last name

culture

string

User's culture/locale (e.g., fr-FR, en-US)

userType

string · enum

The type of user

Enum values:

User

Supervisor

Administrator

Create a new user › Responses

Created

id

integer · int32

Unique identifier

identifier

string

firstName

string

lastName

string

culture

string

userType

string

status

string · enum

The object status

Enum values:

Active

Inactive

POST/users

curl --request POST \
  --url https://api.versohq.dev/users \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "identifier": "identifier",
  "firstName": "firstName",
  "lastName": "lastName",
  "culture": "culture",
  "userType": "User"
}
'

shell

Example Request Body

{
  "identifier": "identifier",
  "firstName": "firstName",
  "lastName": "lastName",
  "culture": "culture",
  "userType": "User"
}

json

Example Responses

{
  "id": 0,
  "identifier": "identifier",
  "firstName": "firstName",
  "lastName": "lastName",
  "culture": "culture",
  "userType": "userType",
  "status": "Active"
}

json

application/json

Divisions

List users for your tenant

GET

https://api.versohq.dev

/users

Retrieves all users associated with your tenant (automatically determined from your API Key).

List users for your tenant › query Parameters

filter

string

The OData filter expression (with support for attribute fields)

orderBy

string

The OData order-by expression (with support for attribute fields)

result

string · enum

The query result type: items, count or items with count (default: result items)

The query result type

Enum values:

Items

Count

ItemsWithCount

select

string

The OData field selection expression

skip

integer · int64

The number of items in the queried collection that are to be skipped

status

string · enum

The object status (default: all status)

The object status

Enum values:

Active

Inactive

top

integer · int64

The number of items in the queried collection

List users for your tenant › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

List users for your tenant › Responses

object[]

id

integer · int32

Unique identifier

identifier

string

firstName

string

lastName

string

culture

string

userType

string

status

string · enum

The object status

Enum values:

Active

Inactive

Create a new user

POST

https://api.versohq.dev

/users

Creates a new user for your tenant.

Create a new user › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Create a new user › Request Body

identifier

string · required

Unique identifier for the user (typically email)

firstName

string

User's first name

lastName

string

User's last name

culture

string

User's culture/locale (e.g., fr-FR, en-US)

userType

string · enum

The type of user

Enum values:

User

Supervisor

Administrator

Create a new user › Responses

Created

id

integer · int32

Unique identifier

identifier

string

firstName

string

lastName

string

culture

string

userType

string

status

string · enum

The object status

Enum values:

Active

Inactive