List all premises

Will fetch a list of profiles.

GET https://app.copyfactory.io/api/v2/premises/list/

An array with all profiles. Each entry in the array is a separate profile object.

Query Parameters

Name	Type	Description
profile_id	String	The profile ID to further filter results.
premise_type	String	The premise type to further filter results. The options are either "email" or "sentence".

Headers

Name	Type	Description
Authorization*	string	Copyfactory API key

200: OK Success

{
	"data": [{
	'id': 502,
	'premise_name': 'Subject line generator',
	'required_variables': ['client_name', 'how_client_helps'],
	'profile_name': 'APP',
	'premise_type': 'email'
}, {
	'id': 529,
	'premise_name': 'Short follow up email',
	'required_variables': ['client_name', 'client_value_proposition', 'how_client_helps', 'product_name'],
	'profile_name': 'APP',
	'premise_type': 'email'
}, {
	'id': 530,
	'premise_name': 'A relevant question',
	'required_variables': ['client_value_proposition'],
	'profile_name': 'APP',
	'premise_type': 'email'
}, {
	'id': 531,
	'premise_name': 'Section: Value section',
	'required_variables': ['client_name', 'client_value_proposition', 'how_client_helps'],
	'profile_name': 'APP',
	'premise_type': 'email'
}, {
	'id': 543,
	'premise_name': 'Section: A relevant question',
	'required_variables': ['client_value_proposition'],
	'profile_name': 'APP',
	'premise_type': 'email'
}]
}

Shell

curl --location --request GET 'https://app.copyfactory.io/api/v2/premises/list/' \
--header 'Authorization: API-KEY'

Python