Get users

Get a list of users.

Pass a value for the limit parameter in your request if you want retrieve a paginated result. Otherwise API returns a list with all users without pagination.

GET /iam/users

Get users

cURL

curl --request GET \
  --url https://api.gcore.com/iam/users \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.gcore.com/iam/users"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.gcore.com/iam/users', 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://api.gcore.com/iam/users",
  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: <api-key>"
  ],
]);

$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://api.gcore.com/iam/users"

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

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.gcore.com/iam/users")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gcore.com/iam/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "count": 123,
  "results": [
    {
      "id": 123,
      "email": "[e-mail]",
      "name": "<string>",
      "phone": "<string>",
      "company": "<string>",
      "reseller": 123,
      "client": 123,
      "deleted": true,
      "groups": [
        {
          "id": 1,
          "name": "Administrators"
        }
      ],
      "activated": true,
      "sso_auth": true,
      "two_fa": true,
      "auth_types": [],
      "is_active": true,
      "client_and_roles": [
        {
          "client_id": 123,
          "client_company_name": "<string>",
          "user_roles": [
            "2"
          ],
          "user_id": 123
        }
      ]
    }
  ],
  "next": "/users?offset=20&limit=10",
  "previous": "/users?offset=10&limit=10"
}

Authorizations

Authorization · string · header · required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Query Parameters

limit · integer

The maximum number of items.

offset · integer

Offset relative to the beginning of list.

Response

200

application/json

OK

count · integer · required

Total number of users

results · object[] · required

Show child attributes

next · string

URL to the next users slice

Example:

"/users?offset=20&limit=10"

previous · string

URL to the previous users slice

Example:

"/users?offset=10&limit=10"