The REST API

The REST API allows you to retrieve and update the data that is stored inside Copernica from out of your own website or app. You can write your own scripts that send requests and instructions to our servers to fetch this data or to update it. You can use this API to automatically synchronize the data in Copernica with your own system, without any human interference.

REST API: method reference

The following table lists all methods that are accessible through HTTP GET, POST, PUT en DELETE:

Methode Adres Omschrijving
GET api.copernica.com/identity Fetch API access token identity
GET api.copernica.com/databases Fetch databases
POST api.copernica.com/databases Create a new database
GET api.copernica.com/database/$id Fetch database settings
PUT api.copernica.com/database/$id Modify database settings
DELETE api.copernica.com/database/$id Remove a database
GET api.copernica.com/database/$id/unsubscribe Fetch unsubscribe behavior
PUT api.copernica.com/database/$id/unsubscribe Set unsubscribe behavior
GET api.copernica.com/database/$id/fields Fetch database fields
POST api.copernica.com/database/$id/fields Create database field
PUT api.copernica.com/database/$id/field/$id Edit database field
DELETE api.copernica.com/database/$id/field/$id Remove database field
GET api.copernica.com/database/$id/interests Fetch interests
POST api.copernica.com/database/$id/interests Create interest
GET api.copernica.com/database/$id/collections Fetch collections
POST api.copernica.com/database/$id/collections Create collection
GET api.copernica.com/database/$id/profiles Fetch profiles
POST api.copernica.com/database/$id/profiles Create new profile
PUT api.copernica.com/database/$id/profiles Edit multiple profiles
GET api.copernica.com/database/$id/profileids Fetch profile identifiers
GET api.copernica.com/database/$id/views Fetch selections
POST api.copernica.com/database/$id/views Create new selection
GET api.copernica.com/view/$id Fetch selection data
PUT api.copernica.com/view/$id Update selection data
DELETE api.copernica.com/view/$id Remove selection
GET api.copernica.com/view/$id/profiles Fetch profiles from selection
GET api.copernica.com/view/$id/profileids Fetch profile identifiers
GET api.copernica.com/view/$id/rules Fetch selection rules
POST api.copernica.com/view/$id/rules Create selection rules
GET api.copernica.com/view/$id/rule/$id Fetch selection rule
GET api.copernica.com/view/$id/views Fetch nested selections
POST api.copernica.com/view/$id/views Create a nested selection
GET api.copernica.com/rule/$id Fetch selection rule
PUT api.copernica.com/rule/$id Edit selection rule
DELETE api.copernica.com/rule/$id Remove selection rule
GET api.copernica.com/rule/$id/conditions Get selection conditions
POST api.copernica.com/rule/$id/conditions Create a selection condition
GET api.copernica.com/profile/$id Fetch profile data
PUT api.copernica.com/profile/$id Edit profile data
DELETE api.copernica.com/profile/$id Remove profile
GET api.copernica.com/profile/$id/fields Fetch profile fields
PUT api.copernica.com/profile/$id/fields Edit profile fields
GET api.copernica.com/profile/$id/interests Fetch profile interests
POST api.copernica.com/profile/$id/interests Add interests to profile
PUT api.copernica.com/profile/$id/interests Overwrite profile interests
GET api.copernica.com/profile/$id/subprofiles Fetch subprofiles of a profile
POST api.copernica.com/profile/$id/subprofiles Create subprofile
GET api.copernica.com/collection/$id Fetch collection data
PUT api.copernica.com/collection/$id Edit collection data
GET api.copernica.com/collection/$id/fields Fetch collection fields
POST api.copernica.com/collection/$id/fields Create collection field
PUT api.copernica/com/collection/$id/field/$id Edit colection field
DELETE api.copernica.com/collection/$id/field/$id Remove collection field
GET api.copernica.com/collection/$id/miniviews Fetch miniselections
POST api.copernica.com/collection/$id/miniviews Create miniselection
GET api.copernica.com/collection/$id/subprofiles Fetch subprofiles from a collection
GET api.copernica.com/collection/$id/subprofileids Fetch subprofile IDs from a collection
GET api.copernica.com/collection/$id/unsubscribe Fetch collection unsubscribe behavior
PUT api.copernica.com/collection/$id/unsubscribe Update collection unsubscribe behavior
GET api.copernica.com/miniview/$id Fetch miniselection data
PUT api.copernica.com/miniview/$id Update miniselection data
DELETE api.copernica.com/miniview/$id Remove miniselection
GET api.copernica.com/miniview/$id/subprofiles Fetch subprofiles in a miniselection
GET api.copernica.com/miniview/$id/subprofileids Fetch subprofile identifiers
GET api.copernica.com/miniview/$id/rules Fetch miniselection rules
POST api.copernica.com/miniview/$id/rules Create miniselection rule
GET api.copernica.com/miniview/$id/rule/$id Fetch miniselection rule
GET api.copernica.com/minirule/$id Fetch miniselection rule
PUT api.copernica.com/minirule/$id Edit miniselection rule
DELETE api.copernica.com/minirule/$id Remove miniselection rule
GET api.copernica.com/minirule/$id/conditions Fetch conditions for a miniselection
POST api.copernica.com/minirule/$id/conditions Create condition for a miniselection
GET api.copernica.com/subprofile/$id Fetch subprofile data
GET api.copernica.com/subprofile/$id/fields Fetch subprofile fields
GET api.copernica.com/logfiles Fetch all logfiles
GET api.copernica.com/logfiles/$name Download logfile in CSV format
GET api.copernica.com/logfiles/$name/json Download logfile in JSON format
GET api.copernica.com/logfiles/$name/xml Download logfile in XML format