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>'
{
  "next": "https://api-sandbox.argyle.com/v2/employments?cursor=ZXhhbXBsZV9jdXJzb3I",
  "previous": null,
  "results": [
    {
      "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.

​
limit
integer

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

​
cursor
string

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

Response

200 - application/json

A list of employment objects.

​
results
object[]
required
​
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.