Employments
Learn about the /employments
endpoint.
Employment objects contain information related to the employment information of the user: employment status and type, hire and termination dates, etc. The data in an employment object is tied to a particular payroll account that the user has connected via Argyle Link.
#The employment object
- #idstring (uuid)
Unique ID of the employment object associated with a user's payroll account.
- #accountstring (uuid)
ID of the payroll account associated with the employment object.
- #employerstring
The name of the company or entity that employs the user.
- #statusstring (enum)
Status of employment.
- #typestring (enum)
Type of employment. Generally, you file Form 1099 for a contractor and Form W-2 for all other types of employment.
- #job_titlestring
The current job title of the user. The value will usually be a free-form text returned from the payroll provider—for example, sales associate, driver.
- #hire_datetimestring (datetime)
The date when the user was hired by the employer. Timestamps follow the ISO 8601 standard.
- #termination_datetimestring (datetime)
The date when the user's employment was terminated by the employer. Timestamps follow the ISO 8601 standard.
- #termination_reasonstring
Reason for the termination event. Free-form text entry provided by the employer or payroll provider.
- #base_pay.amountinteger
A fixed amount of money paid to a user, not including any bonuses, commission, or other discretionary incentives.
- #base_pay.periodstring (enum)
The unit of time
base_pay.amount
corresponds to.biweekly
occurs every two weeks whilesemimonthly
occurs twice a month. - #base_pay.currencystring
A user's base pay currency. Currencies follow the ISO 4217 format.
- #pay_cyclestring (enum)
The frequency at which the user gets paid.
biweekly
occurs every two weeks whilesemimonthly
occurs twice a month. - #platform_ids.employee_idstring
A unique ID assigned to a user by an employer.
- #platform_ids.position_idstring
A unique ID assigned to a position by an employer.
- #platform_ids.platform_user_idstring
A unique ID assigned to a user by a payroll provider.
- #platform_user_id *DEPRECATEDstring
Deprecated in favor of
platform_ids.platform_user_id
. - #metadataobject
Metadata holds additional available, often unstructured, information about this data resource.
- #created_atstring (timestamp)
Time at which the employment object was created. Timestamps follow the ISO 8601 standard.
- #updated_atstring (timestamp)
Time at which the employment object was last updated. Timestamps follow the ISO 8601 standard.
1{
2 "id": "857b4aad-1a55-4200-84f7-311cd3dc3432",
3 "account": "021a1749-6973-4e47-a82a-307008ca88cc",
4 "employer": "walmart",
5 "created_at": "2020-10-27T17:29:08.724441Z",
6 "updated_at": "2020-10-27T17:29:08.724520Z",
7 "status": "active",
8 "type": "part-time",
9 "job_title": "cashier",
10 "hire_datetime": "2018-10-27T17:29:08.724441Z",
11 "termination_datetime": null,
12 "termination_reason": null,
13 "base_pay": {
14 "amount": 36400,
15 "period": "annual",
16 "currency": "USD"
17 },
18 "pay_cycle": "monthly",
19 "platform_ids": {
20 "employee_id": "47FJ06ON8",
21 "position_id": "INA609028",
22 "platform_user_id": "H3WTY0FHMQ24ERDN"
23 },
24 "metadata": {}
25}
#Retrieve an employment
- Retrieve an employment object with the supplied ID.
- This request returns an employment object if a valid identifier was provided.
- #idstring (uuid)required
The identifier of the employment to be retrieved.
1curl --request GET \
2 --url https://api.argyle.com/v1/employments/{id} \
3 --header 'accept: application/json' \
4 --header 'content-type: application/json'
1{
2 "id": "0180519e-7161-2f64-e84a-840207f960a4",
3 "account": "0180519e-64f5-0107-603a-a460f85c2c50",
4 "status": "active",
5 "type": "part-time",
6 "job_title": "1635 - Helpline Agent",
7 "platform_user_id": "3TLS6GT3XIKJNZRQ",
8 "hire_datetime": "2014-07-30T19:27:57Z",
9 "termination_datetime": "2022-05-22T14:12:58Z",
10 "termination_reason": "Poor quality of work.",
11 "employer": "amazin",
12 "metadata": {},
13 "base_pay": {
14 "amount": "44.51",
15 "period": "hourly",
16 "currency": "USD"
17 },
18 "pay_cycle": "monthly",
19 "created_at": "2022-04-22T14:12:59.874015Z",
20 "updated_at": "2022-04-22T14:12:59.874046Z",
21 "platform_ids": {
22 "employee_id": "2Y8LCCCVG",
23 "position_id": "93X4D03S5",
24 "platform_user_id": "3TLS6GT3XIKJNZRQ"
25 }
26}
#List employments
- List employment objects.
- This request returns an object with a
results
property that contains an array of up tolimit
employment objects.
1curl --request GET \
2 --url https://api.argyle.com/v1/employments?limit=2 \
3 --header 'accept: application/json' \
4 --header 'content-type: application/json'
1[
2 {
3 "id": "0180519e-7161-2f64-e84a-840207f960a4",
4 "account": "0180519e-64f5-0107-603a-a460f85c2c50",
5 "status": "active",
6 "type": "part-time",
7 "job_title": "1635 - Helpline Agent",
8 "platform_user_id": "3TLS6GT3XIKJNZRQ",
9 "hire_datetime": "2014-07-30T19:27:57Z",
10 "termination_datetime": "2022-05-22T14:12:58Z",
11 "termination_reason": "Poor quality of work.",
12 "employer": "amazin",
13 "metadata": {},
14 "base_pay": {
15 "amount": "44.51",
16 "period": "hourly",
17 "currency": "USD"
18 },
19 "pay_cycle": "monthly",
20 "created_at": "2022-04-22T14:12:59.874015Z",
21 "updated_at": "2022-04-22T14:12:59.874046Z",
22 "platform_ids": {
23 "employee_id": "2Y8LCCCVG",
24 "position_id": "93X4D03S5",
25 "platform_user_id": "3TLS6GT3XIKJNZRQ"
26 }
27 },
28 {
29 "id": "01805174-1a57-4251-baf0-333a2eb95750",
30 "account": "01805161-796d-b3f1-a0c0-8250dc01efe4",
31 "status": "active",
32 "type": "contractor",
33 "job_title": null,
34 "platform_user_id": "418IMWASXATWBW2X",
35 "hire_datetime": null,
36 "termination_datetime": null,
37 "termination_reason": null,
38 "employer": "udre",
39 "metadata": {},
40 "base_pay": {
41 "amount": null,
42 "currency": null,
43 "period": null
44 },
45 "pay_cycle": null,
46 "created_at": "2022-04-22T13:26:45.079884Z",
47 "updated_at": "2022-04-22T13:26:45.079932Z",
48 "platform_ids": {
49 "employee_id": null,
50 "position_id": null,
51 "platform_user_id": "418IMWASXATWBW2X"
52 }
53 }
54]