List guides

GET

Returns guides in an account

Path parameters

environmentIdstringRequired

ID of the environment

Headers

X-Disable-Hooks"true"Required

Response

This endpoint returns an object.

datalist of objects

Errors

GET

1 curl https://api.x.flatfile.com/v1/environments/environmentId/guides \
2      -H "X-Disable-Hooks: true" \
3      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "data": [
3     {
4       "id": "id",
5       "slug": "slug",
6       "title": "title",
7       "versions": [
8         {
9           "id": "id",
10           "version": 1,
11           "content": "content",
12           "createdAt": "2024-01-15T09:30:00Z",
13           "updatedAt": "2024-01-15T09:30:00Z"
14         },
15         {
16           "id": "id",
17           "version": 1,
18           "content": "content",
19           "createdAt": "2024-01-15T09:30:00Z",
20           "updatedAt": "2024-01-15T09:30:00Z"
21         }
22       ],
23       "blocks": [
24         {
25           "blocks": {
26             "key": "value"
27           }
28         },
29         {
30           "blocks": {
31             "key": "value"
32           }
33         }
34       ],
35       "createdAt": "2024-01-15T09:30:00Z",
36       "updatedAt": "2024-01-15T09:30:00Z",
37       "description": "description",
38       "metadata": {
39         "metadata": {
40           "key": "value"
41         }
42       }
43     },
44     {
45       "id": "id",
46       "slug": "slug",
47       "title": "title",
48       "versions": [
49         {
50           "id": "id",
51           "version": 1,
52           "content": "content",
53           "createdAt": "2024-01-15T09:30:00Z",
54           "updatedAt": "2024-01-15T09:30:00Z"
55         },
56         {
57           "id": "id",
58           "version": 1,
59           "content": "content",
60           "createdAt": "2024-01-15T09:30:00Z",
61           "updatedAt": "2024-01-15T09:30:00Z"
62         }
63       ],
64       "blocks": [
65         {
66           "blocks": {
67             "key": "value"
68           }
69         },
70         {
71           "blocks": {
72             "key": "value"
73           }
74         }
75       ],
76       "createdAt": "2024-01-15T09:30:00Z",
77       "updatedAt": "2024-01-15T09:30:00Z",
78       "description": "description",
79       "metadata": {
80         "metadata": {
81           "key": "value"
82         }
83       }
84     }
85   ]
86 }

Built with

1	curl https://api.x.flatfile.com/v1/environments/environmentId/guides \
2	-H "X-Disable-Hooks: true" \
3	-H "Authorization: Bearer <token>"

1	{
2	"data": [
3	{
4	"id": "id",
5	"slug": "slug",
6	"title": "title",
7	"versions": [
8	{
9	"id": "id",
10	"version": 1,
11	"content": "content",
12	"createdAt": "2024-01-15T09:30:00Z",
13	"updatedAt": "2024-01-15T09:30:00Z"
14	},
15	{
16	"id": "id",
17	"version": 1,
18	"content": "content",
19	"createdAt": "2024-01-15T09:30:00Z",
20	"updatedAt": "2024-01-15T09:30:00Z"
21	}
22	],
23	"blocks": [
24	{
25	"blocks": {
26	"key": "value"
27	}
28	},
29	{
30	"blocks": {
31	"key": "value"
32	}
33	}
34	],
35	"createdAt": "2024-01-15T09:30:00Z",
36	"updatedAt": "2024-01-15T09:30:00Z",
37	"description": "description",
38	"metadata": {
39	"metadata": {
40	"key": "value"
41	}
42	}
43	},
44	{
45	"id": "id",
46	"slug": "slug",
47	"title": "title",
48	"versions": [
49	{
50	"id": "id",
51	"version": 1,
52	"content": "content",
53	"createdAt": "2024-01-15T09:30:00Z",
54	"updatedAt": "2024-01-15T09:30:00Z"
55	},
56	{
57	"id": "id",
58	"version": 1,
59	"content": "content",
60	"createdAt": "2024-01-15T09:30:00Z",
61	"updatedAt": "2024-01-15T09:30:00Z"
62	}
63	],
64	"blocks": [
65	{
66	"blocks": {
67	"key": "value"
68	}
69	},
70	{
71	"blocks": {
72	"key": "value"
73	}
74	}
75	],
76	"createdAt": "2024-01-15T09:30:00Z",
77	"updatedAt": "2024-01-15T09:30:00Z",
78	"description": "description",
79	"metadata": {
80	"metadata": {
81	"key": "value"
82	}
83	}
84	}
85	]
86	}