REST API: GET miniview subprofiles

Warning: You are viewing the documentation for the old REST API. We recommend using version 2 of the REST API.

Subprofiles are to a collection what regular profiles are to a database. To request the subprofiles that represent a certain profile from a miniview you can send an HTTP GET request to the following URL:$id/subprofile?access_token=xxxx

The $id should be replaced with the numerical identifier of the miniview you're requesting the subprofiles of.

Returned fields

This method returns an array of subprofiles of a miniview. These subprofiles are JSON objects with the following properties:

  • id: unique numerical identifier of the subprofile
  • secret: secret code associated with the subprofile
  • fields: fields belonging to the subprofile
  • profile: ID of the profile the subprofile belongs to
  • collection: ID of the collection the subprofile belongs to
  • created: timestamp of when the profile was created in YYYY-MM-DD hh:mm:ss format
  • modified: timestamp of when the profile was last modified in YYYY-MM-DD hh:mm:ss format

PHP Example

The following PHP script demonstrates how to use the API method.

// dependencies

// change this into your access token
$api = new CopernicaRestApi("your-access-token");

// do the call, and print result

The example above requires the CopernicaRestApi class.

More information