Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
43 lines (27 sloc) 1.21 KB

REST API: GET subprofile identifiers

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

This is a simple method to fetch all IDs of subprofiles in a collection. To use the method send an HTTP GET request to the following URL:

https://api.copernica.com/v1/collection/$id/subprofileids?access_token=xxxx

The $id should be replaced with the numerical identifier of the collection you want to get the IDs of.

Available parameters

This method doesn't support any parameters.

Returned fields

This method returns a JSON array holding the unique numerical identifiers of the subprofiles from the given collection.

PHP Example

The following PHP script demonstrates how to call this API method.

// dependencies
require_once('copernica_rest_api.php');
   
// change this into your access token
$api = new CopernicaRestApi("your-access-token");

// do the call, and print result
print_r($api->get("collection/1234/subprofileids"));

The example above requires the CopernicaRestApi class.

More information

You can’t perform that action at this time.