Find Background Folders | Amniscient Documentation

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

A status code denoting success or failure.

folderslist of objects

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

totalinteger

The total number of folders found based on your query.

limitinteger

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

pageinteger

The starting page of the response results.

400

Bad Request Error

401

Unauthorized Error

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	"total": 1,
13	"limit": 10,
14	"page": 1
15	}