copyfactory.io
  • Getting started
    • Overview
      • Authentication
      • Rate limiting
      • Errors
  • API
    • Playbooks
      • The playbook object
      • List playbooks
    • Sequences
      • The sequence object
      • List sequences
    • Contacts
      • The contact object
      • Create contact
      • Get contact
      • Search contacts
    • Profiles
      • The profile object
      • Get a profile
      • List all profiles
    • Premises
      • The premise object
      • Get a premise
      • List all premises
    • Generations
      • The generations object
      • Generate text
  • Text Generation Tutorials
    • How to generate text
  • App
    • Website
    • Login
Powered by GitBook
On this page
  1. API
  2. Premises

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

{
	"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'
}]
}
curl --location --request GET 'https://app.copyfactory.io/api/v2/premises/list/' \
--header 'Authorization: API-KEY'
import requests

url = "https://app.copyfactory.io/api/v2/premises/list/"

headers = {
  'Authorization': 'API-KEY'
}

response = requests.request("GET", url, headers=headers)

print(response.text)
PreviousGet a premiseNextGenerations

Last updated 2 years ago