List guides

GET

https://api.x.flatfile.com/v1/environments/:environmentId/guides

Returns guides in an account

AuthorizationBearer

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

environmentIdstringRequired

ID of the environment

This endpoint returns an object.

datalist of objects

1	{
2	"data": [
3	{
4	"id": "us_gu_YOUR_ID",
5	"slug": "getting-started",
6	"title": "Importing your data",
7	"versions": [],
8	"blocks": [],
9	"createdAt": "2023-10-30T16:59:45.735Z",
10	"updatedAt": "2023-10-30T16:59:45.735Z",
11	"description": "Getting started guide",
12	"metadata": {
13	"category": "onboarding"
14	}
15	}
16	]
17	}

1	import { FlatfileClient } from "@flatfile/api";
2
3	const client = new FlatfileClient({ token: "YOUR_TOKEN" });
4	await client.environments.listGuides("us_env_YOUR_ID");