REST API v1: GET collection fields

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

A collection is a nested second layer within a database, that also contains fields. To fetch these fields an HTTP GET request can be made to the following URL:

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

The $id should be replaced by the unique numerical identifier of the collection you want to get the fields from.

Available parameters

The following parameters can be added to the URL as variables for the request:

  • start: first field to request
  • limit: length of the request batch
  • total: boolean value for showing available fields

More information about the use of these parameters can be found in the article on paging.

Returned fields

This method returns a list of fields from the database. Each field object contains the following information:

  • ID: numerical field ID
  • name: field name
  • type: field type

PHP Example

The following PHP script shows an example of how to call this method with the API:

// dependencies
require_once('copernica_rest_api.php');

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

// parameters to pass to the call
$parameters = array(
   'limit'     =>  100
);

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

The example above requires the CopernicaRestApi class.

More information