API Reference > Part II: Authenticate using JWT > Manage data collections > Retrieve the consumer accesses of a data collection
  

Retrieve the consumer accesses of a data collection

Use a REST API to retrieve the consumer accesses that are associated with a data collection.

Endpoint and method

The following table describes the connection properties for the API:
Property
Description
Endpoint
/api/v2/data-collections/<dataCollectionId>/consumer-accesses
<dataCollectionId>: Required. Enter the system-generated unique identifier of the data collection for which you want to retrieve the consumer access details.
For more information about how you can use an API to get the system-generated unique identifier of a data collection, see Retrieve all data collections.
To get the system-generated unique identifier of a data collection from the Data Marketplace user interface, open the data collection. The data collection page's URL contains the unique identifier.
For example, in the URL https://{{CDMP_URL}}/datacollection/25158afc-3dfb-44ef-8f3e-cec1e171d0f1?dtn=&tab=summary, the unique identifier is 25158afc-3dfb-44ef-8f3e-cec1e171d0f1.
Method
GET
For more information about how you can call an API, see Authenticate using JWT.

Request

The following table describes the parameters that you enter in the request query:
Parameter
Description
Additional Information
offset
Optional. Specify the starting index for the paginated results.
Default value is 0.
limit
Optional. Specify the maximum number of results that are displayed on a page.
Default value is 20.
Maximum value is 200.
Note: The API has no payload.

Example request

The following example shows how you can use an API to retrieve the details of the consumer accesses that are associated with a data collection:
https://{{CDMP_URL}}/api/v2/data-collections/2593524d-82f7-4dfd-bc6b-17088c046f9d/consumer-accesses

Response

When you invoke the API using a REST client, the client displays a response for the parameter values that you have entered.
The following example shows the response of an API call to retrieve the details of the consumer accesses that are associated with a data collection:
{
"pageInfo": {
"offset": 40,
"limit": 20,
"totalCount": 150
},
"links": {
"self": {
"href": "/data-collections/{dataCollectionId}/consumer-accesses?offset=40&limit=20"
},
"first": {
"href": "/data-collections/{dataCollectionId}/consumer-accesses?offset=0&limit=20"
},
"next": {
"href": "/data-collections/{dataCollectionId}/consumer-accesses?offset=60&limit=20"
},
"previous": {
"href": "/data-collections/{dataCollectionId}/consumer-accesses?offset=20&limit=20"
},
"last": {
"href": "/data-collections/{dataCollectionId}/consumer-accesses?offset=140&limit=20"
}
},
"items": [
{
"id": "b93c4539-a93e-440d-a4b4-95d69b8911e6",
"externalId": "CAS-123",
"costCenter": "IT-DEPT-001",
"status": "AVAILABLE",
"accessGrantedOn": "2025-08-01",
"consumer":
{
"stakeholderId": "jaXM6NrqsKXffdwg2NkTMR",
"userType": "USER",
"roleId": "Stakeholder_Role_Marketplace_Editor",
"isInherited": false
},
"assetGroups": [
{
"id": "c1a86a0e-7690-4577-99ab-be4b193e7d90",
"name": "ASIA",
"isInherited": true
}
]
}
]
}
The following table describes the parameters of each consumer access that is retrieved:
Parameter
Description
pageInfo > offset
Starting index of the paginated results.
pageInfo > limit
The maximum number of results that are displayed on a page.
pageInfo > totalCount
Number of consumer accesses retrieved.
links > self > href
The API that was invoked to generate this response.
links > first > href
The API endpoint that you can use to retrieve the search results that are displayed on the first page.
links > next > href
The API endpoint that you can use to retrieve the search results from the page following the one you currently have open.
links > previous > href
The API endpoint that you can use to retrieve the search results from the page prior to the one you currently have open.
links > last > href
The API endpoint that you can use to retrieve the search results that are displayed on the last page.
id
System-generated unique identifier of the consumer access.
externalId
Reference identifier of the consumer access.
costCenter
Cost center of the Data User that was granted access to the data collection.
status
Status of the consumer access.
A consumer access can have the following statuses:
  • - AVAILABLE. The Data User has access to the data collection.
  • - PENDING_WITHDRAW. A request is submitted to withdraw the Data User's access to the data collection.
  • - WITHDRAWN. The Data User's access to the data collection is withdrawn.
accessGrantedOn
Date on which the Data User was granted access to the data collection.
consumer
Details about the Data User that was granted access to the data collection.
assetGroups
Details of the asset group that is assigned to the category that contains the data collection that is associated with the consumer access.
assetGroups > id
System-generated identifier of the asset group.
assetGroups > name
Name of the asset group.
assetGroups > isInherited
Indicates whether the asset group is directly assigned to the category or if the asset group is inherited from the category hierarchy.
This parameter can have one of the following values:
  • - true. The asset group is inherited from the category hierarchy.
  • - false. The asset group is directly assigned to the category.