Find Background Folders

Find existing background image folders within your organization's library.

organization_idstringRequiredformat: "uuid"

Your organization's unique identifier.

typestringRequired

For the query of background folders, this value should always be 'BACKGROUND'.

searchstringOptional

A search term to filter your background folder results by folder name.

pagedoubleOptional

The starting page of the response results. By default, response results will begin on page 1.

limitdoubleOptional

The number of results per page in the response. By default, pages will have 10 results per page.

200 - Folders retrieved successfully

statusstring or null

A status code denoting success or failure.

folderslist of objects or null

An array of folders returned based on your query. If a folder was not found, this array will be empty.

totaldouble or null

The total number of folders found based on your query.

limitdouble or null

The number of results per page in the response. By default, pages will have 10 results per page.

pagedouble or null

The starting page of the response results.

1	import requests
2
3	url = "https://api.amniscient.com/folder/background"
4
5	querystring = {"organization_id":"organization_id","type":"type","page":"1","limit":"10"}
6
7	headers = {"x-api-key": "x-api-key"}
8
9	response = requests.get(url, headers=headers, params=querystring)
10
11	print(response.json())

1	{
2	"status": "success",
3	"folders": [
4	{
5	"id": "folder-123",
6	"name": "my-background-folder",
7	"type": "BACKGROUND",
8	"created_by": "example@amniscient.com",
9	"created_at": "2023-10-01T12:00:00Z"
10	},
11	{
12	"id": "folder-456",
13	"name": "my-background-folder",
14	"type": "BACKGROUND",
15	"created_by": "example@amniscient.com",
16	"created_at": "2023-10-01T12:00:00Z"
17	}
18	],
19	"total": 2,
20	"limit": 10,
21	"page": 1
22	}