Visit our website

Users

Users are the entities who interact with the system.

https://api.validere.io/app

Create a User

Create a user

post
Body
idstring · uuidOptionalDefault: 0007bb10-5367-4d41-ad10-b05468b52529
namestring · min: 1 · max: 100Required
emailstring · emailRequired
phonestring | nullableOptional
quicksightbooleanOptionalDefault: false
statusstring · enumOptionalDefault: activePossible values:
timezonestringOptionalDefault: US/CentralExample: America/Los_Angeles
Responses
200

A successful operation

application/json
post
POST /app/v1/users HTTP/1.1
Host: api.validere.io
Content-Type: application/json
Accept: */*
Content-Length: 169

{
  "id": "0007bb10-5367-4d41-ad10-b05468b52529",
  "name": "text",
  "email": "[email protected]",
  "phone": "text",
  "quicksight": false,
  "status": "active",
  "timezone": "America/Los_Angeles"
}
200

A successful operation

{
  "id": "a6877768-18a7-4371-b3b2-f9a89f9dc6f2",
  "name": "text",
  "email": "[email protected]",
  "phone": "text",
  "quicksight": false,
  "status": "active",
  "timezone": "America/Los_Angeles",
  "company_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "text",
  "created_by": "123e4567-e89b-12d3-a456-426614174000",
  "updated_at": "text",
  "updated_by": "123e4567-e89b-12d3-a456-426614174000"
}

Delete a User

Delete a user

delete
Path parameters
idstring · uuidRequired

User ID

Responses
200

successful operation

delete
DELETE /app/v1/users/{id} HTTP/1.1
Host: api.validere.io
Accept: */*
200

successful operation

No content

Update a User

Update a user

put
Path parameters
idstring · uuidRequired

User ID

Body
namestring · min: 1 · max: 100Optional
phonestring | nullableOptional
quicksightbooleanOptionalDefault: false
statusstring · enumOptionalDefault: activePossible values:
timezonestringOptionalDefault: US/CentralExample: America/Los_Angeles
Responses
200

A successful operation

application/json
put
PUT /app/v1/users/{id} HTTP/1.1
Host: api.validere.io
Content-Type: application/json
Accept: */*
Content-Length: 100

{
  "name": "text",
  "phone": "text",
  "quicksight": false,
  "status": "active",
  "timezone": "America/Los_Angeles"
}
200

A successful operation

{
  "id": "a6877768-18a7-4371-b3b2-f9a89f9dc6f2",
  "name": "text",
  "email": "[email protected]",
  "phone": "text",
  "quicksight": false,
  "status": "active",
  "timezone": "America/Los_Angeles",
  "company_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "text",
  "created_by": "123e4567-e89b-12d3-a456-426614174000",
  "updated_at": "text",
  "updated_by": "123e4567-e89b-12d3-a456-426614174000"
}

Get a User

Get a user

get
Path parameters
idstring · uuidRequired

User ID

Responses
200

A successful operation

application/json
get
GET /app/v1/users/{id} HTTP/1.1
Host: api.validere.io
Accept: */*
200

A successful operation

{
  "id": "a6877768-18a7-4371-b3b2-f9a89f9dc6f2",
  "name": "text",
  "email": "[email protected]",
  "phone": "text",
  "quicksight": false,
  "status": "active",
  "timezone": "America/Los_Angeles",
  "company_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "text",
  "created_by": "123e4567-e89b-12d3-a456-426614174000",
  "updated_at": "text",
  "updated_by": "123e4567-e89b-12d3-a456-426614174000"
}

Search Users

Search users

post
Body
all ofOptional
and
and
Responses
200

successful operation

application/json
Responseall of
post
POST /app/v1/users/search HTTP/1.1
Host: api.validere.io
Content-Type: application/json
Accept: */*
Content-Length: 413

{
  "page": 0,
  "page_size": 20,
  "sort_by": "name",
  "sort_direction": "desc",
  "filter": {
    "created_at": "2025-08-19T00:27:36.066Z",
    "updated_at": "2025-08-19T00:27:36.066Z",
    "created_by": "123e4567-e89b-12d3-a456-426614174000",
    "updated_by": "123e4567-e89b-12d3-a456-426614174000",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "quicksight": true,
    "timezone": "America/Los_Angeles",
    "status": "active",
    "email": "[email protected]"
  }
}
200

successful operation

{
  "page_number": 0,
  "page_size": 10,
  "total_entries": 58,
  "total_pages": 6,
  "data": [
    {
      "id": "a6877768-18a7-4371-b3b2-f9a89f9dc6f2",
      "name": "text",
      "email": "[email protected]",
      "phone": "text",
      "quicksight": false,
      "status": "active",
      "timezone": "America/Los_Angeles",
      "company_id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "text",
      "created_by": "123e4567-e89b-12d3-a456-426614174000",
      "updated_at": "text",
      "updated_by": "123e4567-e89b-12d3-a456-426614174000",
      "user_groups": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        }
      ],
      "user_groups_count": 1,
      "roles": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text"
        }
      ],
      "roles_count": 1
    }
  ]
}
PreviousRecordsNextRoles

Last updated