List Forms

GET

http://localhost:5000/myinstance1/forms

GET

/myinstance1/forms

$ curl -G http://localhost:5000/myinstance1/forms \
>      -H "Authorization: Bearer <token>" \
>      -d offset=1 \
>      -d limit=1

200Retrieved

1 {
2   "results": [
3     {
4       "id": "06585f0c-539b-4ed5-85cc-a834d15da2e6",
5       "domain": "IT",
6       "title": "Local Admin Access",
7       "url": "https;//myportal.system.com/forms/06585f0c-539b-4ed5-85cc-a834d15da2e6",
8       "last_updated_at": "2022-10-20T07:00:00Z",
9       "image_url": "https://www.moveworks.com/hubfs/img/site/backgrounds/whats-new.svg",
10       "description": "Lorem Ipsum",
11       "short_description": "Lorem Ipsum",
12       "fields": [
13         {
14           "name": "permissions",
15           "label": "Which permissions do you need?",
16           "type": "LABEL",
17           "placeholder": "Enter text here.",
18           "help": "If you need help figuring out which access you need, ask your bot.",
19           "default_to_current_user": false,
20           "options": [
21             {
22               "label": "System Administrator",
23               "value": "system_administrator"
24             }
25           ],
26           "required": false,
27           "visible": true
28         }
29       ],
30       "dynamic_field_rules": [
31         {
32           "name": "Hide 2FA if write access not needed",
33           "conditions": [
34             {
35               "field_name": "2fa_device",
36               "operator": "EQUALS",
37               "value": true
38             }
39           ],
40           "actions": [
41             {
42               "field_name": "read_or_write",
43               "visible": false,
44               "required": true
45             }
46           ],
47           "logical": "AND"
48         }
49       ]
50     }
51   ]
52 }

Forms should be returned from this API in a deterministic order. Deterministic order is desired if we decide to use pagination. Anticipated load – Moveworks will call this endpoint to iterate over all forms provided by this endpoint once every 24 hours. This API is primarily used for ingestion.

List Forms

GET

http://localhost:5000/myinstance1/forms

GET

/myinstance1/forms

$ curl -G http://localhost:5000/myinstance1/forms \
>      -H "Authorization: Bearer <token>" \
>      -d offset=1 \
>      -d limit=1

200Retrieved

1 {
2   "results": [
3     {
4       "id": "06585f0c-539b-4ed5-85cc-a834d15da2e6",
5       "domain": "IT",
6       "title": "Local Admin Access",
7       "url": "https;//myportal.system.com/forms/06585f0c-539b-4ed5-85cc-a834d15da2e6",
8       "last_updated_at": "2022-10-20T07:00:00Z",
9       "image_url": "https://www.moveworks.com/hubfs/img/site/backgrounds/whats-new.svg",
10       "description": "Lorem Ipsum",
11       "short_description": "Lorem Ipsum",
12       "fields": [
13         {
14           "name": "permissions",
15           "label": "Which permissions do you need?",
16           "type": "LABEL",
17           "placeholder": "Enter text here.",
18           "help": "If you need help figuring out which access you need, ask your bot.",
19           "default_to_current_user": false,
20           "options": [
21             {
22               "label": "System Administrator",
23               "value": "system_administrator"
24             }
25           ],
26           "required": false,
27           "visible": true
28         }
29       ],
30       "dynamic_field_rules": [
31         {
32           "name": "Hide 2FA if write access not needed",
33           "conditions": [
34             {
35               "field_name": "2fa_device",
36               "operator": "EQUALS",
37               "value": true
38             }
39           ],
40           "actions": [
41             {
42               "field_name": "read_or_write",
43               "visible": false,
44               "required": true
45             }
46           ],
47           "logical": "AND"
48         }
49       ]
50     }
51   ]
52 }

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

X-API-KEYstring

API Key authentication via header

Query parameters

offsetlongRequired

Given a deterministically ordered list of articles, skips this many forms before returning form records

limitlongRequired

Number of forms to return in a single query. Recommended max: 100 records / request.

Response headers

X-RateLimit-Limitinteger

The maximum number of requests you're permitted to make per minute.

X-RateLimit-Remaininginteger

The number of requests remaining in the current rate limit window.

X-RateLimit-Resetstring

The remaining window before the rate limit FULLY resets in UTC epoch seconds.

Response

List of forms

resultslist of objects

$	curl -G http://localhost:5000/myinstance1/forms \
>	-H "Authorization: Bearer <token>" \
>	-d offset=1 \
>	-d limit=1

1	{
2	"results": [
3	{
4	"id": "06585f0c-539b-4ed5-85cc-a834d15da2e6",
5	"domain": "IT",
6	"title": "Local Admin Access",
7	"url": "https;//myportal.system.com/forms/06585f0c-539b-4ed5-85cc-a834d15da2e6",
8	"last_updated_at": "2022-10-20T07:00:00Z",
9	"image_url": "https://www.moveworks.com/hubfs/img/site/backgrounds/whats-new.svg",
10	"description": "Lorem Ipsum",
11	"short_description": "Lorem Ipsum",
12	"fields": [
13	{
14	"name": "permissions",
15	"label": "Which permissions do you need?",
16	"type": "LABEL",
17	"placeholder": "Enter text here.",
18	"help": "If you need help figuring out which access you need, ask your bot.",
19	"default_to_current_user": false,
20	"options": [
21	{
22	"label": "System Administrator",
23	"value": "system_administrator"
24	}
25	],
26	"required": false,
27	"visible": true
28	}
29	],
30	"dynamic_field_rules": [
31	{
32	"name": "Hide 2FA if write access not needed",
33	"conditions": [
34	{
35	"field_name": "2fa_device",
36	"operator": "EQUALS",
37	"value": true
38	}
39	],
40	"actions": [
41	{
42	"field_name": "read_or_write",
43	"visible": false,
44	"required": true
45	}
46	],
47	"logical": "AND"
48	}
49	]
50	}
51	]
52	}