List users - Alvys

GET

api

{version}

users

list

List users

curl --request GET \
  --url https://integrations.alvys.com/api/p/v{version}/users/list \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://integrations.alvys.com/api/p/v{version}/users/list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://integrations.alvys.com/api/p/v{version}/users/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://integrations.alvys.com/api/p/v{version}/users/list"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

[
  {
    "Id": "<string>",
    "UserName": "<string>",
    "Name": "<string>",
    "UserType": "<string>",
    "Role": "Admin",
    "CompanyCode": "<string>",
    "Status": "Active",
    "Permissions": [
      "<string>"
    ],
    "Email": "<string>",
    "Phone": "<string>",
    "CreatedAt": "2023-11-07T05:31:56Z",
    "ModifiedAt": "2023-11-07T05:31:56Z"
  }
]

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

The List Users API endpoint is used for fetching comprehensive details of all users, helping administrators and managers keep track of user accounts and their associated roles and permissions within the Alvys system. The inclusion of versioning in the URL path ensures compatibility with different API versions as the platform evolves. For more information on versioning, refer to the Versioning page.

Request Parameters

The following parameter is required in the URL path:

Parameter	Type	Required	Description
version	String	Yes	The version of the API being requested.

Example CURL request

curl --location 'https://integrations.alvys.com/api/p/v{version}/users/list' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Replace {version} with the API version number and YOUR_ACCESS_TOKEN with your actual Bearer token.

curl --location 'https://integrations.alvys.com/api/p/v1/users/list' \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ...'

Response Parameters

The response contains a list of users, each represented by the following parameters:

Parameter	Type	Description
Id	String	The unique identifier of the user.
UserName	String	The username of the user.
Name	String	The full name of the user.
Email	String	The email address of the user.
UserType	String	The type of user (e.g., Internal, External).
Role	String	The role assigned to the user (e.g., Admin, Dispatcher, Driver, Biller, SalesAgent, DataEntry, Safety, OperationManager).
Phone	String	The phone number of the user.
CompanyCode	String	The code of the company the user is associated with.
Status	String	The current status of the user (e.g., Active, Disabled, Deleted).
Permissions	Array of Strings	A list of permissions assigned to the user.
CreatedAt	String (Date-Time)	The date and time when the user was created.
ModifiedAt	String (Date-Time)	The date and time when the user’s details were last modified.

Example Response

On the right side, you can see examples of different error codes by clicking “Example” and selecting the response code.

Rate Limits

All endpoints are subject to rate limits to protect the API from traffic spikes. For detailed information on rate limits, please refer to the Rate Limits section. This page is interactive, allowing you to try a request without any parameters. The Curl command on the right side of the page will be automatically updated. Alternatively, you can directly edit the Curl command. Make sure to authorize yourself before trying a request.

Authorizations

Authorization

string

header

required

OAuth 2.0 client-credentials access token. Obtain one from https://auth.alvys.com/oauth/token (grant_type=client_credentials, audience=https://api.alvys.com/public/), then paste it here. The playground sends it as Authorization: Bearer <token>.

Path Parameters

version

string

default:1.0

required

API version (e.g., 1.0)

Example:

"1.0"

Response

string

required

UserName

string

required

Name

string

required

UserType

string

required

Role

enum<string>

required

Available options:

Admin,

Dispatcher,

Driver,

Biller,

SalesAgent,

DataEntry,

Safety,

OperationManager

CompanyCode

string

required

Status

enum<string>

required

Available options:

Active,

Disabled,

Deleted

Permissions

string[]

required

string | null

Phone

string | null

CreatedAt

string<date-time> | null

ModifiedAt

string<date-time> | null

⌘I

List users

curl --request GET \
  --url https://integrations.alvys.com/api/p/v{version}/users/list \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://integrations.alvys.com/api/p/v{version}/users/list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://integrations.alvys.com/api/p/v{version}/users/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://integrations.alvys.com/api/p/v{version}/users/list"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

[
  {
    "Id": "<string>",
    "UserName": "<string>",
    "Name": "<string>",
    "UserType": "<string>",
    "Role": "Admin",
    "CompanyCode": "<string>",
    "Status": "Active",
    "Permissions": [
      "<string>"
    ],
    "Email": "<string>",
    "Phone": "<string>",
    "CreatedAt": "2023-11-07T05:31:56Z",
    "ModifiedAt": "2023-11-07T05:31:56Z"
  }
]

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

{
  "Type": "<string>",
  "Title": "<string>",
  "Status": 123,
  "Detail": "<string>",
  "Instance": "<string>"
}

​Request Parameters

​Example CURL request

​Response Parameters

​Example Response

​Rate Limits

Authorizations

Path Parameters

Response

Request Parameters

Example CURL request

Response Parameters

Example Response

Rate Limits