Warning: You are viewing the documentation for the old REST API. We recommend using version 2 of 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.


GET methods are used to fetch data. The following GET methods are available:

Method Address Description
GET Fetch API access token identity
GET Fetch databases
GET$id Fetch database settings
GET$id/unsubscribe Fetch unsubscribe behavior
GET$id/fields Fetch database fields
GET$id/interests Fetch interests
GET$id/collections Fetch collections
GET$id/profiles Fetch profiles
GET$id/profileids Fetch profile identifiers
GET$id/views Fetch selections
GET$id Fetch selection data
GET$id/profiles Fetch profiles from selection
GET$id/profileids Fetch profile identifiers
GET$id/rules Fetch selection rules
GET$id/rule/$id Fetch selection rule
GET$id/views Fetch nested selections
GET$id Fetch selection rule
GET$id/conditions Get selection conditions
GET$id/ Fetch profile data
GET$id/events Fetch profile events
GET$id/fields Fetch profile fields
GET$id/interests Fetch profile interests
GET$id/subprofiles Fetch subprofiles of a profile
GET$id Fetch collection data
GET$id/fields Fetch collection fields
GET$id/miniviews Fetch miniviews
GET$id/subprofiles Fetch subprofiles from a collection
GET$id/subprofileids Fetch subprofile IDs from a collection
GET$id/unsubscribe Fetch collection unsubscribe behavior
GET$id Fetch miniview data
GET$id/subprofiles Fetch subprofiles in a miniview
GET$id/subprofileids Fetch subprofile identifiers
GET$id/rules Fetch miniview rules
GET$id/rule/$id Fetch miniview rule
GET$id Fetch miniselection rule
GET$id/conditions Fetch conditions for a miniselection
GET$id/ Fetch subprofile data
GET$id/events Fetch subprofile events
GET$id/fields Fetch subprofile fields
GET Fetch all document data
GET Fetch all logfiles
GET$date Logfile names
GET$name Download logfile in CSV format
GET$name/json Download logfile in JSON format
GET$name/xml Download logfile in XML format
GET$addres/events Fetch email events
GET$id/events Fetch MS message events
GET$id/body/ Fetch MS message body (HTML/MIME/text)
GET$id/events Fetch MS template events
GET$id/events Fetch Publisher template events
GET$id/events Fetch Publisher message events
GET$id/events Fetch Publisher document events
GET$tag/events Fetch tag events
GET$id/data Fetch data from a datarequest
GET$id/status Fetch status of a datarequest

See also the general article on events.


PUT and POST methods are used to create and edit data. They are often very similar. If you can not find a POST method of what you are looking for there might be a PUT method to do it. It also works the other way around. The following PUT and POST methods are available:

Method Address Description
POST Create a new database
PUT$id Modify database settings
PUT$id/unsubscribe Set unsubscribe behavior
POST$id/fields Create database field
PUT$id/field/$id Edit database field
POST$id/interests Create interest
POST$id/collections Create collection
POST$id/profiles Create new profile
PUT$id/profiles Edit multiple profiles
POST$id/views Create new selection
PUT$id Update selection data
POST$id/rules Create selection rules
POST$id/views Create a nested selection
PUT$id Edit selection rule
POST$id/conditions Create a selection condition
PUT$id/conditions/$type Edit selection condition
PUT$id Edit profile data
PUT$id/fields Edit profile fields
POST$id/interests Add interests to profile
PUT$id/interests Edit profile interests
POST$id/subprofiles Create subprofile
PUT$id/subprofiles Edit subprofile
POST$id/datarequest Request all data regarding a profile
POST$id/fields Create collection field
PUT api.copernica/com/v1/collection/$id/field/$id Edit collection field
PUT$id Edit collection data
POST$id/miniviews Create miniview
PUT$id/unsubscribe Update collection unsubscribe behavior
PUT$id Update miniview data
POST$id/rules Create miniview rule
PUT$id Edit miniselection rule
POST$id/conditions Create condition for a miniselection
PUT$id/conditions/$type Edit condition for a miniselection
POST$id/datarequest Request all data regarding a subprofile
POST$email/datarequest Request all data regarding an email address


DELETE methods are used to delete data. This is permanent, so always be careful and double check your calls. The following DELETE methods are available:

Method Address Description
DELETE$id/field/$id Remove database field
DELETE$id Remove selection
DELETE$id Remove selection rule
DELETE$id Remove profile
DELETE$id/field/$id Remove collection field
DELETE$id Remove miniview
DELETE$id Remove miniselection rule