Get a guide

GET

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

Returns a guide

AuthorizationBearer

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

environmentIdstringRequired

ID of the environment

guideIdstringRequired

ID of guide

This endpoint returns an object.

dataobject

A guide

1	from flatfile import Flatfile
2
3	client = Flatfile(
4	token="YOUR_TOKEN",
5	)
6	client.environments.get_guide(
7	environment_id="us_env_YOUR_ID",
8	guide_id="us_gu_YOUR_ID",
9	)

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