Skip to main content
API docs by Redocly

Sharing API (v1)

Download OpenAPI specification:Download

URL: https://api.enablenow.nl

Shares

Retrieve a list of shares

Authorizations:
bearer
query Parameters
isExpired
boolean or null

Filters all expired shares from the results

page
integer <int32>
Default: 1

Page number to retrieve (optional) (defaults to 1)

pageSize
integer <int32>
Default: 50

Number of results to retrieve per page (optional) (defaults to 50)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "_pagination": {
    }
}

Create a new share

Authorizations:
bearer
Request Body schema: application/json
required

The share model used to create a new share

clientId
required
string

The EnableNow ClientId of the app to share with

reference
string or null

The external reference of this share

expirationDateUtc
string or null <date-time>

The expiration date of this share. (defaults to 1 day from now)

consentIds
Array of strings or null <guid> [ items <guid > ]

An array of EnableNow Consent identifiers to share

accountIds
Array of strings or null <guid> [ items <guid > ]

An array of EnableNow Account identifiers to share

analysisIds
Array of strings or null <guid> [ items <guid > ]

An array of EnableNow Analysis identifiers to share

Responses

Request samples

Content type
application/json
{
  • "clientId": "string",
  • "reference": "string",
  • "expirationDateUtc": "2019-08-24T14:15:22Z",
  • "consentIds": [
    ],
  • "accountIds": [
    ],
  • "analysisIds": [
    ]
}

Response samples

Content type
application/json
{
  • "data": "string"
}

Retrieve a share by its EnableNow identifier

Authorizations:
bearer
path Parameters
shareId
required
string <guid>

The EnableNow identifier of the share

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Updates an existing share by its EnableNow identifier

Authorizations:
bearer
path Parameters
shareId
required
string <guid>

The EnableNow identifier of the share

Request Body schema: application/json
required

The share model used to update the share

expirationDateUtc
string or null <date-time>

The expiration date of this share. (defaults to 1 day from now)

Responses

Request samples

Content type
application/json
{
  • "expirationDateUtc": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "traceId": "string",
  • "errors": {
    }
}

Deletes an existing share by its EnableNow identifier

Authorizations:
bearer
path Parameters
shareId
required
string <guid>

The EnableNow identifier of the share

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "traceId": "string",
  • "errors": {
    }
}