curl --request GET \
--url https://api-sandbox.argyle.com/v2/identities/{id} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api-sandbox.argyle.com/v2/identities/{id}"
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/identities/{id}', 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/identities/{id}",
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/identities/{id}"
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/identities/{id}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.argyle.com/v2/identities/{id}")
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{
"id": "0153b145-7ab9-bea2-cc16-a8b71328942f",
"account": "0187c66e-e7e5-811c-b006-2232f00f426a",
"address": {
"city": "New York",
"line1": "852 North W St",
"line2": "Apt 221",
"state": "NY",
"country": "US",
"postal_code": "10014"
},
"first_name": "Sarah",
"last_name": "Longfield",
"full_name": "Sarah Longfield",
"birth_date": "1980-10-30",
"email": "[email protected]",
"phone_number": "+12125555555",
"picture_url": "www.argyle.com/logofoldername",
"employment_status": "active",
"employment_type": "full-time",
"job_title": "Store Manager",
"ssn": "522-09-1191",
"marital_status": "Married filing jointly",
"gender": "Female",
"original_hire_date": "2019-01-03",
"hire_date": "2020-04-08",
"termination_date": null,
"termination_reason": null,
"employer": "Whole Goods",
"employment": "0183d52a-d3b2-331d-c753-3662a20e352b",
"base_pay": {
"amount": "58024.50",
"period": "annual",
"currency": "USD"
},
"pay_cycle": "semimonthly",
"platform_ids": {
"employee_id": "OB238HDW5",
"position_id": "6ELL4O7PM",
"platform_user_id": "JLH7B9V6O6YGN9O7"
},
"created_at": "2023-01-30T12:53:24.561594Z",
"updated_at": "2023-01-30T12:55:06.478699Z",
"metadata": {}
}Retrieve An Identity
Retrieves an identity object.
curl --request GET \
--url https://api-sandbox.argyle.com/v2/identities/{id} \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://api-sandbox.argyle.com/v2/identities/{id}"
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/identities/{id}', 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/identities/{id}",
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/identities/{id}"
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/identities/{id}")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.argyle.com/v2/identities/{id}")
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{
"id": "0153b145-7ab9-bea2-cc16-a8b71328942f",
"account": "0187c66e-e7e5-811c-b006-2232f00f426a",
"address": {
"city": "New York",
"line1": "852 North W St",
"line2": "Apt 221",
"state": "NY",
"country": "US",
"postal_code": "10014"
},
"first_name": "Sarah",
"last_name": "Longfield",
"full_name": "Sarah Longfield",
"birth_date": "1980-10-30",
"email": "[email protected]",
"phone_number": "+12125555555",
"picture_url": "www.argyle.com/logofoldername",
"employment_status": "active",
"employment_type": "full-time",
"job_title": "Store Manager",
"ssn": "522-09-1191",
"marital_status": "Married filing jointly",
"gender": "Female",
"original_hire_date": "2019-01-03",
"hire_date": "2020-04-08",
"termination_date": null,
"termination_reason": null,
"employer": "Whole Goods",
"employment": "0183d52a-d3b2-331d-c753-3662a20e352b",
"base_pay": {
"amount": "58024.50",
"period": "annual",
"currency": "USD"
},
"pay_cycle": "semimonthly",
"platform_ids": {
"employee_id": "OB238HDW5",
"position_id": "6ELL4O7PM",
"platform_user_id": "JLH7B9V6O6YGN9O7"
},
"created_at": "2023-01-30T12:53:24.561594Z",
"updated_at": "2023-01-30T12:55:06.478699Z",
"metadata": {}
}Response
Date of birth in ISO 8601 format. If values are obfuscated (rare), a dash will replace the value (e.g. --01-31 when the year is obfuscated).
"1980-10-30"
Phone number E.164 international format).
"+12125555555"
Job status of the employment relevant to the identity.
- Definitions of
inactiveandterminatedvary by Item and can overlap.inactivetypically indicates the employee left voluntarily, is on leave, or has not been active for a certain period of time.terminatedtypically indicates the employee is no longer employed. Specific reasons for termination, if available, are returned in thetermination_reasonfield.
- We recommend using data from the
/paystubsand/gigsendpoints to construct a more wholistic timeline of employment history.
active, inactive, terminated "active"
Type of employment.
Employment type enum definitions
full-time- Employment in which an individual is regularly scheduled to work 30 or more hours per week, or meets the employer's internal threshold for a standard full-time workweek.
- Examples:
full-time employee,36+ hours weekly
part-time- Employment in which an individual is regularly scheduled to work fewer than 30 hours per week, or meets the employer's internal threshold for a standard part-time workweek.
- Examples:
PT regular,20+ hours weekly
contractor- Work performed by an individual engaged for a specific project or timeframe who is not an employee of the organization.
- Examples:
gig worker,contract employee,contract worker,freelancer
military- Compensation derived from active-duty or reserve military service.
- Automatically set for military platforms.
benefits- Non-wage compensation or government-issued assistance.
- Automatically set for benefits platforms.
seasonal- Employment that occurs at approximately the same time each year, typically lasting six months or less.
- Examples:
seasonal on-call,seasonal part-time,peak seasonal
temporary- Short-term employment with a defined end date, usually lasting one year or less.
- Examples:
internship,substitute employee,temporary full-time,temporary part-time
regular- Ongoing employment with no specified end date that does not fall into more specialized categories.
- Examples:
permanent,W-2,salaried
other- Work or income that does not fit standard classifications.
- Examples:
variable,casual,employee,PRN (on-call)
full-time, part-time, contractor, military, benefits, seasonal, temporary, regular, other "full-time"
Timestamp (ISO 8601) of the user's earliest employment start date.
"2019-01-03"
Timestamp (ISO 8601) of the user's most recent employment start date.
hire_date may differ from original_hire_date due to a promotion, a re-hiring event, or similar.
"2020-04-08"
Timestamp (ISO 8601) when the user was terminated.
null
Employment ID. Can be used as a filter when listing identities.
"0183d52a-d3b2-331d-c753-3662a20e352b"
Timestamp (ISO 8601) when the identity object was created.
"2023-01-30T12:53:24.561594Z"
Timestamp (ISO 8601) when a property value of the identity object most recently changed.
"2023-01-30T12:55:06.478699Z"