User Forms
User form submissions.
User forms are response forms (see Step 4) that users can submit as a fallback when they cannot find their employer or payroll provider.
#The user form object
Attributes
Example
1{
2 "id": "0186ef31-4a6c-bc77-ffb7-a9db11505d7d",
3 "account": "0182c1e2-59ec-16ba-34e2-4f20594a7df7",
4 "data": {
5 "income_source": "Block & Fish Tackle",
6 "payroll_provider": "Payroll Corp."
7 },
8 "created_at": "2023-03-17T10:50:30.414265Z",
9 "updated_at": "2023-03-17T10:50:31.621908Z"
10}#Retrieve a user form
get/v2/user-forms/{id}
Retrieves a user form object.
Path parameters
- #idstring (uuid)required
ID of the user form object to be retrieved.
Example Request
1curl --request GET \
2 --url https://api.argyle.com/v2/user-forms/{id} \
3 --header 'accept: application/json' \
4 --header 'content-type: application/json'Example Response
1{
2 "id": "0186ef31-4a6c-bc77-ffb7-a9db11505d7d",
3 "account": "0182c1e2-59ec-16ba-34e2-4f20594a7df7",
4 "data": {
5 "income_source": "Block & Fish Tackle",
6 "payroll_provider": "Payroll Corp."
7 },
8 "created_at": "2023-03-17T10:50:30.414265Z",
9 "updated_at": "2023-03-17T10:50:31.621908Z"
10}#List all user forms
get/v2/user-forms
Returns an array of all user form objects.
Example Request
1curl --request GET \
2 --url https://api.argyle.com/v2/user-forms?limit=2 \
3 --header 'accept: application/json' \
4 --header 'content-type: application/json'Example Response
1[
2 {
3 "id": "0186ef31-4a6c-bc77-ffb7-a9db11505d7d",
4 "account": "0182c1e2-59ec-16ba-34e2-4f20594a7df7",
5 "data": {
6 "income_source": "Block & Fish Tackle",
7 "payroll_provider": "Payroll Corp."
8 },
9 "created_at": "2023-03-17T10:50:30.414265Z",
10 "updated_at": "2023-03-17T10:50:31.621908Z"
11 },
12 {
13 "id": "0187bf23-cd80-118d-c0b8-58023e21c8e5",
14 "account": "01856c65-43b6-8b5d-b32a-56b8fbda5c28",
15 "data": {
16 "income_source": "Spanner & Gear Innovations",
17 "payroll_provider": "Payroll Corp."
18 },
19 "created_at": "2023-03-17T10:40:00.672839Z",
20 "updated_at": "2023-03-17T10:45:20.035736Z"
21 }
22]