v1

latestOpenAPI 3.0.12026-07-243686491.1 MB

Deeplinks

Retrieve a list of deeplinks

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

get/api/v1/deeplinks

Query parameters

pageinteger

page number to retrieve (starts with 0)

perPageinteger

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

operatorIdinteger nullable

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

Example:1

fromCreatedAtstring date nullable

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

Example:2025-06-26

fromUpdatedAtstring date nullable

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

Example:2025-06-26

Response

List of deeplinks that match the criteria

Example response

{
  "data": [
    {
      "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"
    }
  ]
}