Skip to main content

Retrieve shares

Using the access token requested in the authentication chapter, retrieve all Shares of your app using endpoint:

https://api.staging.enablenow.nl/shares

Request query parameters​

You can call this endpoint without any of the following parameters. We always return the records sorted by created date. We will return page 1 (up to 50 records) of all shares found for your clientId.

Parameter
Required
Description
page
No
Page number to retrieve (optional) (defaults to 1)
pageSize
No
Number of results to retrieve per page (optional) (defaults to 50)
isExpired
No
Filters all expired shares from the results

Response model​

The _pagination model contains metadata information about the pagination state.

Property
Type
Availability
Description
page
integer
Required
The page number of the results.
size
integer
Required
The number of results per page.
totalCount
integer
Required
The total number of results.
totalPages
integer
Required
The total number of pages.

Inside the data collection, the share object consists of the following properties:

Property
Type
Availability
Description
id
UUID
Required
The unique EnableNow ID for this share.
clientId
string
Required
The shared EnableNow app identifier
expirationDateUtc
datetime
Required
The expiration date of this share (in UTC)
consentIds
UUID[]
Required
An array of EnableNow Consent identifiers
accountIds
UUID[]
Required
An array of EnableNow Account identifiers
analysisIds
UUID[]
Required
An array of EnableNow Analysis identifiers
reference
string
Optional
The external reference of this share

Response model example​

{
    "_pagination": {
        "page": 1,
        "size": 50,
        "totalCount": 8,
        "totalPages": 1
    },
    "data": [
        {
            "id": "e50c460d-0e18-4846-41e9-08de94a79554",
            "clientId": "en-app-ref-002",
            "reference": "my-internal-reference-1",
            "expirationDateUtc": "2026-04-15T12:00:00+02:00",
            "consentIds": [],
            "accountIds": [
                "590d7709-5aca-48b8-de16-08de7916b96f"
            ],
            "analysisIds": []
        },
        [...]
        {
            "id": "e50c460d-0e18-4846-41e9-08de94a79554",
            "clientId": "en-app-ref-001",
            "reference": "my-internal-reference-1",
            "expirationDateUtc": "2026-04-30T12:00:00+02:00",
            "consentIds": [
                "590d7709-5aca-48b8-de16-08de7916b96f"
            ],
            "accountIds": [],
            "analysisIds": []
        }
    ]
}

Retrieve a single share by ID​

If you already know the share identifier, you can retrieve that specific share directly instead of listing all shares first.

Request Method: GET

https://api.staging.enablenow.nl/shares/<share-id>

Required path parameter and headers​

Parameter / Header
Required
Description
shareId
Yes
The EnableNow identifier of the share to retrieve.
Accept: application/json
Yes
Returns the response in JSON format.
Authorization: <token>
Yes
The access token obtained from the authentication chapter.

Request example​

For instance, if you want to retrieve the share with identifier af86536d-34e3-4ebc-6c64-08db56ccef25, you would create a GET request to:

Request Method: GET

https://api.staging.enablenow.nl/shares/af86536d-34e3-4ebc-6c64-08db56ccef25 
Accept: application/json
Authorization: <token>

Response model example​

{
    "data": {
        "id": "af86536d-34e3-4ebc-6c64-08db56ccef25",
        "clientId": "en-app-ref-002",
        "reference": "my-internal-reference-1",
        "expirationDateUtc": "2026-04-15T12:00:00+02:00",
        "consentIds": [],
        "accountIds": [
            "590d7709-5aca-48b8-de16-08de7916b96f"
        ],
        "analysisIds": []
    }
}
info

If you need near-real-time updates or want to keep a local copy of share data in sync, prefer using Webhooks and storing the share identifiers you receive from share events. Direct retrieval by ID is most useful when you already have a specific shareId and need to look up the latest details on demand.