MOmonta
Deeplinks

Retrieve a single deeplink

Changed on

Required scope: deeplinks:read </br>Organization authorization: supported

get/api/v1/deeplinks/{deeplinkId}

Request

  • Base URL
    https://partner-api.monta.com
  • URL
    https://partner-api.monta.com/api/v1/deeplinks/{deeplinkId}
  • Auth
    HTTP bearer

Path parameters

deeplinkIdinteger required

Response

Deeplink with provided id

idinteger

Unique identifier of the deeplink

destinationType'link' | 'resource' required
commentstring nullable

Optional comment for the deeplink

visitsinteger

Number of visits to this deeplink

operatorIdinteger nullable

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

qrCodeUrlstring nullable

URL to the QR code image

appUrlstring nullable

Optional URL for the mobile app

createdAtstring required

Creation timestamp

updatedAtstring required

Last update timestamp

deletedAtstring nullable

Deletion timestamp, if deleted

Example response

{
  "id": 1,
  "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"
}

Changes