Skip to main content
GET
/
partner
/
links
List magic links
curl --request GET \
  --url https://m2m-backend-qa.up.railway.app/partner/links \
  --header 'X-API-Key: <api-key>'
{
  "success": true,
  "data": {
    "items": [
      {
        "linkId": "link_acme_a1b2c3d4e5f6",
        "referenceId": "user-12345",
        "status": "created",
        "url": "https://widget.m2m.leapfinancial.com/link_acme_a1b2c3d4e5f6/m2m-basic",
        "expiresAt": "2026-02-11T12:00:00.000Z",
        "createdAt": "2026-02-10T12:00:00.000Z",
        "openedAt": "2026-02-10T13:00:00.000Z",
        "userId": "user_acme_x1y2z3",
        "operationId": "op_acme_abc123",
        "userData": {
          "name": {}
        }
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 85,
      "totalPages": 5
    }
  }
}

Authorizations

​
X-API-Key
string
header
required

Your partner API key. Use m2m_test_* keys for the sandbox environment.

Query Parameters

​
page
number
default:1

Page number (1-indexed)

Required range: x >= 1
Example:

1

​
limit
number
default:20

Number of items per page

Required range: 1 <= x <= 100
Example:

20

​
from
string

Filter records created on or after this date (ISO 8601)

Example:

"2026-01-01T00:00:00.000Z"

​
to
string

Filter records created on or before this date (ISO 8601)

Example:

"2026-02-28T23:59:59.999Z"

​
visibility
enum<string>

Filter by link visibility. "active" returns links that have not expired and are not revoked. "expired" returns links whose expiresAt has passed but are not revoked. Omit to return all links regardless of expiration.

Available options:
active,
expired
Example:

"active"

​
status
enum<string>

Filter by specific link status. Can be combined with the visibility filter. "created" = link not yet opened. "opened" = user has accessed the link. "revoked" = partner revoked the link.

Available options:
created,
opened,
revoked
Example:

"opened"

​
referenceId
string

Filter links by the partner reference ID of the associated user

Example:

"user-12345"

Response

Paginated list of magic links

​
success
boolean
required
Example:

true

​
data
object
required