Skip to main content
GET
/
v2
/
employments
List all employments
curl --request GET \
  --url https://api-sandbox.argyle.com/v2/employments \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "id": "0186a27d-e5c6-735a-a359-6315b34d544c",
    "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
    "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
    "created_at": "2023-01-30T12:53:24.561Z",
    "employer": "Whole Goods",
    "employment_status": "active",
    "origin": "retrieved"
  },
  {
    "id": "0183d52a-d3b2-331d-c753-3662a20e352b",
    "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
    "account": "0183d52b-a0c3-599a-e901-3676a20a533f",
    "created_at": "2023-01-30T12:53:24.561Z",
    "employer": "Double Double",
    "employment_status": "inactive",
    "origin": "acquired"
  },
  {
    "id": "0183d52a-d3b2-331d-c753-3662a20e352b",
    "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
    "account": "0175a40a-b3b4-622b-a339-8855c57b226e",
    "created_at": "2023-01-30T12:53:24.561Z",
    "employer": "Half Bads",
    "employment_status": "inactive",
    "origin": "retrieved"
  },
  {
    "id": "0183d52a-d3b2-331d-c753-3662a20e352b",
    "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
    "account": "0175a40a-b3b4-622b-a339-8855c57b226e",
    "created_at": "2023-01-30T12:53:24.561Z",
    "employer": "Stardollars LLC",
    "employment_status": "inactive",
    "origin": "retrieved"
  }
]
Either user or account query parameter must be used.

Authorizations

​
Authorization
string
header
required

Username = api_key_id, Password = api_key_secret

Query Parameters

​
user
string<uuid>

Filter by user ID.

​
account
string<uuid>

Filter by account ID.

Response

200 - application/json

A list of employment objects.

​
id
string<uuid>

Unique ID of the employment.

Can be used to filter the following data sets:

​
account
string<uuid>

ID of the account associated with the employment.

​
user
string<uuid>

ID of the user associated with the employment.

​
created_at
string<datetime>

Timestamp (ISO 8601) when the employment object was created.

​
employer
string

Employer name on the most recent paystub associated with the employment.

​
employment_status
enum<string>

Job status of the employment.

inactive and terminated definitions vary by Item and can overlap. inactive typically indicates the employee left voluntarily, is on leave, or has not been active for a certain period of time. terminated typically indicates the employee is no longer employed. Specific reasons for termination, if available, are returned in the termination_reason field.

We recommend using data from the /paystubs and /gigs endpoints to construct a more wholistic timeline of employment history.

Available options:
active,
inactive,
terminated
​
origin
enum<string>

Whether the employment was defined by the connected payroll system or paystubs.

  • retrieved — Employment defined by the connected payroll system.
  • acquired — Employment defined by retrieved paystubs.
Available options:
retrieved,
acquired