Deeplinks

Retrieve a list of deeplinks

GET

https://partner-api.monta.com

/api/v1/deeplinks

Required scope: deeplinks:read
Organization authorization: supported

Retrieve a list of deeplinks › query Parameters

page

integer · int32

page number to retrieve (starts with 0)

Default: 0

perPage

integer · int32

number of items per page (between 1 and 100, default 10)

Default: 10

operatorId

integer | null · int64

Allows filtering deeplinks by operatorId.
*Note:*The operatorId must be in the consumer’s operatorIds or, if empty, belong to the organization’s sub-operators.

Example: 1

fromCreatedAt

string | null · date

Filter to retrieve deeplinks where createdAt >= fromCreatedAt (ISO8601: yyyy-MM-dd)

Example: 2025-06-26

fromUpdatedAt

string | null · date

Filter to retrieve deeplinks where updatedAt >= fromUpdatedAt (ISO8601: yyyy-MM-dd)

Example: 2025-06-26

Retrieve a list of deeplinks › Responses

List of deeplinks that match the criteria

OffsetBasedResponse_20

DeeplinkDto[] · required

MontaPage.Meta · required

GET/api/v1/deeplinks

curl https://partner-api.monta.com/api/v1/deeplinks \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "data": [
    {
      "id": 1,
      "destinationType": "link",
      "destination": {
        "url": "https://example.com"
      },
      "comment": "Marketing campaign link",
      "visits": 42,
      "operatorId": 123,
      "qrCodeUrl": "https://example.com/qr/abc123",
      "appUrl": "monta://deeplink/abc123",
      "createdAt": "2024-01-01T12:00:00Z",
      "updatedAt": "2024-01-01T12:00:00Z",
      "deletedAt": "2024-01-01T12:00:00Z"
    }
  ],
  "meta": {
    "itemCount": 0,
    "currentPage": 0,
    "perPage": 0,
    "totalPageCount": 0,
    "totalItemCount": 0
  }
}

json

application/json

Create a deeplink

POST

https://partner-api.monta.com

/api/v1/deeplinks

Required scope: deeplinks:write
Organization authorization: supported

Create a deeplink › Request Body

CreateDeeplink

destinationType

string · enum · required

Type of destination for the deeplink

Enum values:

link

resource

Example: link

object · required

Destination details for the deeplink

comment

string | null

Optional comment for the deeplink

Example: Marketing campaign link

operatorId

integer | null · int64

The ID of the operator for whom the deeplink will be created. If not provided, operator ID will be derived from the used api credentials

Example: 123

Create a deeplink › Responses

Deeplink created

DeeplinkDto

destinationType

string · enum · required

Type of destination for the deeplink

Enum values:

link

resource

Example: link

createdAt

string · required

Creation timestamp

Example: 2024-01-01T12:00:00Z

updatedAt

string · required

Last update timestamp

Example: 2024-01-01T12:00:00Z

id

integer · int64

Unique identifier of the deeplink

Example: 1

object

Destination details for the deeplink

comment

string | null

Optional comment for the deeplink

Example: Marketing campaign link

visits

integer · int64

Number of visits to this deeplink

Example: 42

operatorId

integer | null · int64

ID of the operator who created the deeplink. Null for deeplinks without an operator (e.g.: permanent charge point links)

Example: 123

qrCodeUrl

string | null

URL to the QR code image

Example: https://example.com/qr/abc123

appUrl

string | null

Optional URL for the mobile app

Example: monta://deeplink/abc123

deletedAt

string | null

Deletion timestamp, if deleted

Example: 2024-01-01T12:00:00Z

POST/api/v1/deeplinks

curl https://partner-api.monta.com/api/v1/deeplinks \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "destinationType": "link",
  "destination": {
    "url": "https://example.com"
  },
  "comment": "Marketing campaign link",
  "operatorId": 123
}'

Example Request Body

{
  "destinationType": "link",
  "destination": {
    "url": "https://example.com"
  },
  "comment": "Marketing campaign link",
  "operatorId": 123
}

json

Example Responses

{
  "id": 1,
  "destinationType": "link",
  "destination": {
    "url": "https://example.com"
  },
  "comment": "Marketing campaign link",
  "visits": 42,
  "operatorId": 123,
  "qrCodeUrl": "https://example.com/qr/abc123",
  "appUrl": "monta://deeplink/abc123",
  "createdAt": "2024-01-01T12:00:00Z",
  "updatedAt": "2024-01-01T12:00:00Z",
  "deletedAt": "2024-01-01T12:00:00Z"
}

json

application/json

Retrieve a single deeplink

GET

https://partner-api.monta.com

/api/v1/deeplinks/{deeplinkId}

Required scope: deeplinks:read
Organization authorization: supported

Retrieve a single deeplink › path Parameters

deeplinkId

integer · int64 · required

Retrieve a single deeplink › Responses

Deeplink with provided id

DeeplinkDto

destinationType

string · enum · required

Type of destination for the deeplink

Enum values:

link

resource

Example: link

createdAt

string · required

Creation timestamp

Example: 2024-01-01T12:00:00Z

updatedAt

string · required

Last update timestamp

Example: 2024-01-01T12:00:00Z

id

integer · int64

Unique identifier of the deeplink

Example: 1

object

Destination details for the deeplink

comment

string | null

Optional comment for the deeplink

Example: Marketing campaign link

visits

integer · int64

Number of visits to this deeplink

Example: 42

operatorId

integer | null · int64

ID of the operator who created the deeplink. Null for deeplinks without an operator (e.g.: permanent charge point links)

Example: 123

qrCodeUrl

string | null

URL to the QR code image

Example: https://example.com/qr/abc123

appUrl

string | null

Optional URL for the mobile app

Example: monta://deeplink/abc123

deletedAt

string | null

Deletion timestamp, if deleted

Example: 2024-01-01T12:00:00Z

Patch an existing deeplink

PATCH

https://partner-api.monta.com

/api/v1/deeplinks/{deeplinkId}

Required scope: deeplinks:write
Organization authorization: supported

Patch an existing deeplink › path Parameters

deeplinkId

integer · int64 · required

Patch an existing deeplink › Request Body

PatchDeeplink

destinationType

string · enum

Type of the destination the deeplink is pointing to

Enum values:

link

resource

Example: link

object

Destination details for the deeplink

comment

string | null

Optional comment related to the deeplink

Example: This deeplink is used for redirecting users to the main location page.

Patch an existing deeplink › Responses

Deeplink updated

DeeplinkDto

destinationType

string · enum · required

Type of destination for the deeplink

Enum values:

link

resource

Example: link

createdAt

string · required

Creation timestamp

Example: 2024-01-01T12:00:00Z

updatedAt

string · required

Last update timestamp

Example: 2024-01-01T12:00:00Z

id

integer · int64

Unique identifier of the deeplink

Example: 1

object

Destination details for the deeplink

comment

string | null

Optional comment for the deeplink

Example: Marketing campaign link

visits

integer · int64

Number of visits to this deeplink

Example: 42

operatorId

integer | null · int64

ID of the operator who created the deeplink. Null for deeplinks without an operator (e.g.: permanent charge point links)

Example: 123

qrCodeUrl

string | null

URL to the QR code image

Example: https://example.com/qr/abc123

appUrl

string | null

Optional URL for the mobile app

Example: monta://deeplink/abc123

deletedAt

string | null

Deletion timestamp, if deleted

Example: 2024-01-01T12:00:00Z

PATCH/api/v1/deeplinks/{deeplinkId}

curl https://partner-api.monta.com/api/v1/deeplinks/:deeplinkId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "destinationType": "link",
  "destination": {
    "url": "https://example.com"
  },
  "comment": "This deeplink is used for redirecting users to the main location page."
}'

Example Request Body

{
  "destinationType": "link",
  "destination": {
    "url": "https://example.com"
  },
  "comment": "This deeplink is used for redirecting users to the main location page."
}

json

Example Responses

{
  "id": 1,
  "destinationType": "link",
  "destination": {
    "url": "https://example.com"
  },
  "comment": "Marketing campaign link",
  "visits": 42,
  "operatorId": 123,
  "qrCodeUrl": "https://example.com/qr/abc123",
  "appUrl": "monta://deeplink/abc123",
  "createdAt": "2024-01-01T12:00:00Z",
  "updatedAt": "2024-01-01T12:00:00Z",
  "deletedAt": "2024-01-01T12:00:00Z"
}

json

application/json

Delete an existing deeplink

DELETE

https://partner-api.monta.com

/api/v1/deeplinks/{deeplinkId}

Required scope: deeplinks:delete
Organization authorization: supported

Delete an existing deeplink › path Parameters

deeplinkId

integer · int64 · required

Delete an existing deeplink › Responses

Deeplink deleted

No data returned

Dashboard Statistics E-invoices