Employments
Individual employments associated with a user or account.
#The employment object
Attributes
- #idstring (uuid)
Unique ID of the employment.
Can be used to filter the following data sets:
— Identities
— Paystubs
— Payroll Documents - #accountstring (uuid)
ID of the account associated with the employment.
- #userstring (uuid)
ID of the user associated with the employment.
- #created_atstring (datetime)
Timestamp (ISO 8601) when the employment object was created.
- #employerstring
Employer name on the most recent paystub associated with the employment.
- #employment_statusstring (enum)
Job status of the employment.
- #originstring (enum)
Whether the employment was defined by the connected payroll system or paystubs.
Example
1{
2 "id": "0183d52a-d3b2-331d-c753-3662a20e352b",
3 "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
4 "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
5 "created_at": "2023-01-30T12:53:24.561594Z",
6 "employer": "Whole Goods",
7 "employment_status": "active",
8 "origin": "retrieved"
9}#List all employments
get/v2/employments
Returns an array of all employment objects.
Query parameters
Either user or account query parameter must be used.
Example Request
1curl --request GET \
2 --url https://api.argyle.com/v2/employments?user=018051aa-f7a9-a0db-2f38-6cfa325e9d69 \
3 --header 'accept: application/json' \
4 --header 'content-type: application/json'Example Response
1[
2 {
3 "id": "0186a27d-e5c6-735a-a359-6315b34d544c",
4 "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
5 "account": "0187c66e-e7e5-811c-b006-2232f00f426a",
6 "created_at": "2023-01-30T12:53:24.561594Z",
7 "employer": "Whole Goods",
8 "employment_status": "active",
9 "origin": "retrieved"
10 },
11 {
12 "id": "0183d52a-d3b2-331d-c753-3662a20e352b",
13 "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
14 "account": "0183d52b-a0c3-599a-e901-3676a20a533f",
15 "created_at": "2023-01-30T12:53:24.561594Z",
16 "employer": "Double Double",
17 "employment_status": "inactive",
18 "origin": "acquired"
19 },
20 {
21 "id": "0183d52a-d3b2-331d-c753-3662a20e352b",
22 "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
23 "account": "0175a40a-b3b4-622b-a339-8855c57b226e",
24 "created_at": "2023-01-30T12:53:24.561594Z",
25 "employer": "Half Bads",
26 "employment_status": "inactive",
27 "origin": "retrieved"
28 },
29 {
30 "id": "0183d52a-d3b2-331d-c753-3662a20e352b",
31 "user": "018051aa-f7a9-a0db-2f38-6cfa325e9d69",
32 "account": "0175a40a-b3b4-622b-a339-8855c57b226e",
33 "created_at": "2023-01-30T12:53:24.561594Z",
34 "employer": "Stardollars LLC",
35 "employment_status": "inactive",
36 "origin": "retrieved"
37 }
38]