List users

GET

users

List users

curl --request GET \
  --url https://api.modernloop.io/v1/users \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.modernloop.io/v1/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.modernloop.io/v1/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: 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://api.modernloop.io/v1/users"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.modernloop.io/v1/users")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": [
    {
      "id": "usr_a1b2c3d4e5f64789a1b2c3d4e5f64789",
      "name": "<string>",
      "email": "jsmith@example.com",
      "title": "<string>",
      "timezone": "<string>",
      "manager_id": "usr_a1b2c3d4e5f64789a1b2c3d4e5f64789",
      "ats": {
        "type": "GREENHOUSE",
        "id": "<string>"
      },
      "load": {
        "daily_interviews": 123,
        "daily_limit": 123,
        "daily_load_limit": {
          "source": "ORG",
          "limit": 123,
          "type": "NUMBER_OF_INTERVIEWS"
        },
        "weekly_interviews": 123,
        "weekly_limit": 123,
        "weekly_load_limit": {
          "source": "ORG",
          "limit": 123,
          "type": "NUMBER_OF_INTERVIEWS"
        }
      },
      "paused": {
        "is_paused": true,
        "until": "2023-11-07T05:31:56Z"
      },
      "pause_dates": [
        {
          "start_at": "2023-11-07T05:31:56Z",
          "end_at": "2023-11-07T05:31:56Z"
        }
      ],
      "work_hours": {
        "source": "ORG",
        "blocks": [
          {
            "day": "<string>",
            "start": "<string>",
            "end": "<string>"
          }
        ]
      },
      "attributes": [
        {
          "attribute_name": {
            "id": "att_a1b2c3d4e5f64789a1b2c3d4e5f64789",
            "name": "<string>",
            "type": "DEPARTMENT"
          },
          "values": [
            {
              "id": "atv_a1b2c3d4e5f64789a1b2c3d4e5f64789",
              "name": "<string>"
            }
          ]
        }
      ],
      "modules": [
        {
          "module": {
            "id": "mod_a1b2c3d4e5f64789a1b2c3d4e5f64789",
            "name": "<string>"
          },
          "training_status": "TRAINED",
          "is_paused": true
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "app_url": "<string>"
    }
  ],
  "pagination": {
    "next_cursor": "<string>"
  }
}

{
  "error": {
    "code": "UNAUTHENTICATED",
    "message": "<string>",
    "docs_url": "<string>",
    "details": [
      {}
    ]
  }
}

{
  "error": {
    "code": "UNAUTHENTICATED",
    "message": "<string>",
    "docs_url": "<string>",
    "details": [
      {}
    ]
  }
}

{
  "error": {
    "code": "UNAUTHENTICATED",
    "message": "<string>",
    "docs_url": "<string>",
    "details": [
      {}
    ]
  }
}

{
  "error": {
    "code": "UNAUTHENTICATED",
    "message": "<string>",
    "docs_url": "<string>",
    "details": [
      {}
    ]
  }
}

{
  "error": {
    "code": "UNAUTHENTICATED",
    "message": "<string>",
    "docs_url": "<string>",
    "details": [
      {}
    ]
  }
}

{
  "error": {
    "code": "UNAUTHENTICATED",
    "message": "<string>",
    "docs_url": "<string>",
    "details": [
      {}
    ]
  }
}

{
  "error": {
    "code": "UNAUTHENTICATED",
    "message": "<string>",
    "docs_url": "<string>",
    "details": [
      {}
    ]
  }
}

Authorizations

Authorization

string

header

required

API tokens are passed as Bearer tokens.

Query Parameters

cursor

string

Opaque pagination cursor from the previous page's pagination.next_cursor, bound to the same query filters.

limit

integer

default:25

Page size. Must be between 1 and 100; defaults to 25.

Required range: 1 <= x <= 100

ids

string[]

Comma-separated list of IDs; maximum 100 values.

Minimum array length: 1

an user ID. Accepts the canonical prefixed compact UUID, a prefixed dashed UUID, a bare dashed UUID, or a bare compact UUID; input is case-insensitive.

Pattern: ^(?:usr_)?(?:[0-9a-fA-F]{32}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

string

Case-insensitive substring search across user name and email; combines with other filters using AND.

name

string

Case-insensitive exact match on the user's full name, given name, or family name; combines with other filters using AND.

string

Case-insensitive exact match on user email; combines with other filters using AND.

statuses

enum<string>[]

Matches users with any listed status; combines with other filters using AND.

Minimum array length: 1

Available options:

ACTIVE,

ARCHIVED

module_ids

string[]

Matches users assigned to any listed interview module; combines with other filters using AND.

Minimum array length: 1

an interview module ID. Accepts the canonical prefixed compact UUID, a prefixed dashed UUID, a bare dashed UUID, or a bare compact UUID; input is case-insensitive.

Pattern: ^(?:mod_)?(?:[0-9a-fA-F]{32}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

manager_ids

string[]

Matches users managed by any listed manager; combines with other filters using AND.

Minimum array length: 1

an user ID. Accepts the canonical prefixed compact UUID, a prefixed dashed UUID, a bare dashed UUID, or a bare compact UUID; input is case-insensitive.

Pattern: ^(?:usr_)?(?:[0-9a-fA-F]{32}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

ats_ids

string[]

Matches users whose ATS ID is one of these exact values; combines with other filters using AND.

Minimum array length: 1

ats_type

enum<string>

Filters by ATS provider.

Available options:

GREENHOUSE,

ASHBY,

LEVER,

WORKDAY,

SMARTRECRUITERS,

GEM,

KOMBO

created_at_gte

string<date-time>

Filters records created at or after this timestamp.

created_at_lte

string<date-time>

Filters records created at or before this timestamp.

updated_at_gte

string<date-time>

Filters records updated at or after this timestamp.

updated_at_lte

string<date-time>

Filters records updated at or before this timestamp.

Response

Success

data

object[]

required

Show child attributes

pagination

object

required

Show child attributes

⌘I

List users

curl --request GET \
  --url https://api.modernloop.io/v1/users \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.modernloop.io/v1/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.modernloop.io/v1/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: 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://api.modernloop.io/v1/users"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.modernloop.io/v1/users")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "data": [
    {
      "id": "usr_a1b2c3d4e5f64789a1b2c3d4e5f64789",
      "name": "<string>",
      "email": "jsmith@example.com",
      "title": "<string>",
      "timezone": "<string>",
      "manager_id": "usr_a1b2c3d4e5f64789a1b2c3d4e5f64789",
      "ats": {
        "type": "GREENHOUSE",
        "id": "<string>"
      },
      "load": {
        "daily_interviews": 123,
        "daily_limit": 123,
        "daily_load_limit": {
          "source": "ORG",
          "limit": 123,
          "type": "NUMBER_OF_INTERVIEWS"
        },
        "weekly_interviews": 123,
        "weekly_limit": 123,
        "weekly_load_limit": {
          "source": "ORG",
          "limit": 123,
          "type": "NUMBER_OF_INTERVIEWS"
        }
      },
      "paused": {
        "is_paused": true,
        "until": "2023-11-07T05:31:56Z"
      },
      "pause_dates": [
        {
          "start_at": "2023-11-07T05:31:56Z",
          "end_at": "2023-11-07T05:31:56Z"
        }
      ],
      "work_hours": {
        "source": "ORG",
        "blocks": [
          {
            "day": "<string>",
            "start": "<string>",
            "end": "<string>"
          }
        ]
      },
      "attributes": [
        {
          "attribute_name": {
            "id": "att_a1b2c3d4e5f64789a1b2c3d4e5f64789",
            "name": "<string>",
            "type": "DEPARTMENT"
          },
          "values": [
            {
              "id": "atv_a1b2c3d4e5f64789a1b2c3d4e5f64789",
              "name": "<string>"
            }
          ]
        }
      ],
      "modules": [
        {
          "module": {
            "id": "mod_a1b2c3d4e5f64789a1b2c3d4e5f64789",
            "name": "<string>"
          },
          "training_status": "TRAINED",
          "is_paused": true
        }
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "app_url": "<string>"
    }
  ],
  "pagination": {
    "next_cursor": "<string>"
  }
}

{
  "error": {
    "code": "UNAUTHENTICATED",
    "message": "<string>",
    "docs_url": "<string>",
    "details": [
      {}
    ]
  }
}

{
  "error": {
    "code": "UNAUTHENTICATED",
    "message": "<string>",
    "docs_url": "<string>",
    "details": [
      {}
    ]
  }
}

{
  "error": {
    "code": "UNAUTHENTICATED",
    "message": "<string>",
    "docs_url": "<string>",
    "details": [
      {}
    ]
  }
}

{
  "error": {
    "code": "UNAUTHENTICATED",
    "message": "<string>",
    "docs_url": "<string>",
    "details": [
      {}
    ]
  }
}

{
  "error": {
    "code": "UNAUTHENTICATED",
    "message": "<string>",
    "docs_url": "<string>",
    "details": [
      {}
    ]
  }
}

{
  "error": {
    "code": "UNAUTHENTICATED",
    "message": "<string>",
    "docs_url": "<string>",
    "details": [
      {}
    ]
  }
}

{
  "error": {
    "code": "UNAUTHENTICATED",
    "message": "<string>",
    "docs_url": "<string>",
    "details": [
      {}
    ]
  }
}

Activity

Application

Candidate

Interview Event

Interview Module

Job Stage

Job

Me

Organization

Schedule

Task Queue

Scheduling Task

Template

User

Authorizations

Query Parameters

Response