Fork me on GitHub

Table Of Contents

You are currently viewing the version 4.1. View another version :

Me collections access¶

About¶

Returns the list of collections for the authenticated user, lists the collections to which he has access and the rights he has.

/api/v1/me/collections

Informations
HTTP Method	GET
Requires Authentication	Yes

The informations returned on the collections are more complete than that of the Me route. The additional attributes are :

name : collection name
logo : logo path representing the collection
labels : label list used for each language

Response Fields¶

Field	Description
collections	Collections informations

Query Sample¶

Note

For all API requests requiring a collection number, use the ** base_id ** attribute (and not ** collection_id **).

curl -v https://mydomain.tld/api/v1/me/collections?oauth_token=xxxxxxx

Response sample¶

{
  "meta": {
    "api_version": "2.0.0",
    "request": "GET /api/v1/me/collections/",
    "response_time": "2021-06-23T18:43:44+02:00",
    "http_code": 200,
    "error_type": null,
    "error_message": null,
    "error_details": null,
    "charset": "UTF-8"
  },
  "response": {
    "collections": [
      {
        "databox_id": 1,
        "base_id": 2,
        "collection_id": 1,
        "name": "Demo Online",
        "logo": "",
        "labels": {
          "fr": "Demo Online",
          "en": "Demo Online",
          "de": "Demo Online",
          "nl": "Demo Online"
        },
        "rights": [
          "actif",
          "canaddrecord",
          "canadmin",
          "cancmd",
          "candeleterecord",
          "candwnldhd",
          "candwnldpreview",
          "canmodifrecord",
          "canpush",
          "canputinalbum",
          "canreport",
          "chgstatus",
          "imgtools",
          "manage",
          "modify_struct",
          "nowatermark"
        ],
        "statuses": [
          {
            "position": 5,
            "labels": {
              "on": {
                "de": "Exclu",
                "en": "Exclu",
                "fr": "Exclu",
                "nl": "Exclu"
              },
              "off": {
                "de": "Libre",
                "en": "Libre",
                "fr": "Libre",
                "nl": "Libre"
              }
            },
            "restricted": false,
            "restriction_flag": false
          },
          {
            "position": 6,
            "labels": {
              "on": {
                "de": "Légende OK",
                "en": "Légende OK",
                "fr": "Légende OK",
                "nl": "Légende OK"
              },
              "off": {
                "de": "Légende à éditer",
                "en": "Légende à éditer",
                "fr": "Légende à éditer",
                "nl": "Légende à éditer"
              }
            },
            "restricted": false,
            "restriction_flag": false
          },
          {
            "position": 7,
            "labels": {
              "on": {
                "de": "Mots clés OK",
                "en": "Mots clés OK",
                "fr": "Mots clés OK",
                "nl": "Mots clés OK"
              },
              "off": {
                "de": "Mots clés à vérifier",
                "en": "Mots clés à vérifier",
                "fr": "Mots clés à vérifier",
                "nl": "Mots clés à vérifier"
              }
            },
            "restricted": false,
            "restriction_flag": false
          },
          {
            "position": 8,
            "labels": {
              "on": {
                "de": "Public",
                "en": "Public",
                "fr": "Public",
                "nl": "Public"
              },
              "off": {
                "de": "Privé",
                "en": "Privé",
                "fr": "Privé",
                "nl": "Privé"
              }
            },
            "restricted": false,
            "restriction_flag": false
          }
        ]
      }
    ]
  }
}