Get a premise

Get a premise object by ID

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

Will get the sentence premise object by ID.

Query Parameters

Name	Type	Description
premise_id*	int	The premise Id you wish to retrieve.

Headers

Name	Type	Description
Authorization*	string	Your Copyfactory API key

200: OK Success

{
    "data": {
        "id": 19,
        "order": 0,
        "is_active": true,
        "required_variables": [
            "person_description"
        ],
        "sentence_premise_name": "Contact",
        "profile_name": "Copyfactory"
    }
}

Shell

curl --location --request GET 'https://app.copyfactory.io/api/v2/premises/get?premise_id=PREMISE-ID/' \
--header 'Authorization: API-KEY'

Python

import requests

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

params = (('premise_id', PREMISE-ID),)

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

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

print(response.text)