Skip to main content
GET
/
v2
/
users
List all users
curl --request GET \
  --url https://api-sandbox.argyle.com/v2/users \
  --header 'Authorization: Basic <encoded-value>'
import requests

url = "https://api-sandbox.argyle.com/v2/users"

headers = {"Authorization": "Basic <encoded-value>"}

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

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api-sandbox.argyle.com/v2/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-sandbox.argyle.com/v2/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: Basic <encoded-value>"
  ],
]);

$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-sandbox.argyle.com/v2/users"

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

	req.Header.Add("Authorization", "Basic <encoded-value>")

	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-sandbox.argyle.com/v2/users")
  .header("Authorization", "Basic <encoded-value>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.argyle.com/v2/users")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body
{
  "next": "https://api-sandbox.argyle.com/v2/users?cursor=ZXhhbXBsZV9jdXJzb3I",
  "previous": null,
  "results": [
    {
      "id": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
      "created_at": "2023-01-30T22:25:38.971Z",
      "items_connected": [
        "item_123456789",
        "item_987654321"
      ],
      "employers_connected": [
        "Whole Goods",
        "Bullseye"
      ],
      "external_metadata": {
        "notes": "In stage 3 of loan approval.",
        "category": "Summer Initiative"
      },
      "external_id": "July Connection",
      "first_name": "Sarah",
      "last_name": "Longfield",
      "email": "sarah@email.com",
      "phone_number": "+12125555555",
      "ssn": null,
      "address": {
        "city": null,
        "line1": null,
        "line2": null,
        "state": null,
        "country": null,
        "postal_code": null
      },
      "birth_date": {
        "year": null,
        "month": null,
        "day": null
      }
    },
    {
      "id": "0186c5b8-8fa1-67b3-39af-14b3e18da8a7",
      "created_at": "2023-01-30T23:25:38.971Z",
      "items_connected": [
        "item_000000001",
        "item_000000002"
      ],
      "employers_connected": [
        "Half Bads",
        "Triple"
      ],
      "external_metadata": {
        "notes": "In stage 1 of loan approval.",
        "category": "Summer Initiative"
      },
      "external_id": "August Connection",
      "first_name": null,
      "last_name": null,
      "email": null,
      "phone_number": null,
      "ssn": null,
      "address": {
        "city": null,
        "line1": null,
        "line2": null,
        "state": null,
        "country": null,
        "postal_code": null
      },
      "birth_date": {
        "year": null,
        "month": null,
        "day": null
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Query Parameters

limit
integer

Number of user objects returned per page. Default: 10. Maximum: 200.

external_id
string

Filter users by external_id. Exact matches only.

cursor
string

The URL returned in next or previous used to retrieve another page of results.

Response

200 - application/json
next
string<uri> | null

URL for the next page of results, if available.

previous
string<uri> | null

URL for the previous page of results, if available.

results
object[]