WarpLink
API Reference

Links

Create, list, get, update, and delete deep links.

POST
/links

Authorization

bearerAuth
AuthorizationBearer <token>

API key in format wl_live_xxx (production) or wl_test_xxx (test).

In: header

Request Body

application/json

destination_url*string
Formaturi
slug?string

Custom slug. Auto-generated if omitted.

Length2 <= length <= 100
ios_url?string
Formaturi
ios_fallback_url?string
Formaturi
android_url?string
Formaturi
android_fallback_url?string
Formaturi
og_title?string
Lengthlength <= 255
og_description?string
og_image_url?string
Formaturi
tags?array<>
Itemsitems <= 20
expires_at?string

Must be in the future.

Formatdate-time
password?string
app_id?string
Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.warplink.app/v1/links" \  -H "Content-Type: application/json" \  -d '{    "destination_url": "http://example.com"  }'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "short_url": "https://aplnk.to/abc123",
  "slug": "abc123",
  "domain": "aplnk.to",
  "destination_url": "http://example.com",
  "ios_url": "http://example.com",
  "ios_fallback_url": "http://example.com",
  "android_url": "http://example.com",
  "android_fallback_url": "http://example.com",
  "og_title": "string",
  "og_description": "string",
  "og_image_url": "http://example.com",
  "app_id": "affd1d10-9538-4fc8-9e0b-4594a28c1335",
  "expires_at": "2019-08-24T14:15:22Z",
  "is_active": true,
  "tags": [
    "string"
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Link not found",
    "details": {
      "fields": [
        {
          "field": "string",
          "message": "string"
        }
      ]
    }
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Link not found",
    "details": {
      "fields": [
        {
          "field": "string",
          "message": "string"
        }
      ]
    }
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Link not found",
    "details": {
      "fields": [
        {
          "field": "string",
          "message": "string"
        }
      ]
    }
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Link not found",
    "details": {
      "fields": [
        {
          "field": "string",
          "message": "string"
        }
      ]
    }
  }
}
GET
/links

Authorization

bearerAuth
AuthorizationBearer <token>

API key in format wl_live_xxx (production) or wl_test_xxx (test).

In: header

Query Parameters

limit?integer
Default20
Range1 <= value <= 100
offset?integer
Default0
Range0 <= value
tag?string
is_active?string
Value in"true" | "false"
search?string
Lengthlength <= 200

Response Body

application/json

application/json

curl -X GET "https://api.warplink.app/v1/links"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "short_url": "https://aplnk.to/abc123",
      "slug": "abc123",
      "domain": "aplnk.to",
      "destination_url": "http://example.com",
      "ios_url": "http://example.com",
      "ios_fallback_url": "http://example.com",
      "android_url": "http://example.com",
      "android_fallback_url": "http://example.com",
      "og_title": "string",
      "og_description": "string",
      "og_image_url": "http://example.com",
      "app_id": "affd1d10-9538-4fc8-9e0b-4594a28c1335",
      "expires_at": "2019-08-24T14:15:22Z",
      "is_active": true,
      "tags": [
        "string"
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "pagination": {
    "total": 0,
    "limit": 0,
    "offset": 0,
    "has_more": true
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Link not found",
    "details": {
      "fields": [
        {
          "field": "string",
          "message": "string"
        }
      ]
    }
  }
}
GET
/links/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

API key in format wl_live_xxx (production) or wl_test_xxx (test).

In: header

Path Parameters

id*string
Formatuuid

Response Body

application/json

application/json

curl -X GET "https://api.warplink.app/v1/links/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "short_url": "https://aplnk.to/abc123",
  "slug": "abc123",
  "domain": "aplnk.to",
  "destination_url": "http://example.com",
  "ios_url": "http://example.com",
  "ios_fallback_url": "http://example.com",
  "android_url": "http://example.com",
  "android_fallback_url": "http://example.com",
  "og_title": "string",
  "og_description": "string",
  "og_image_url": "http://example.com",
  "app_id": "affd1d10-9538-4fc8-9e0b-4594a28c1335",
  "expires_at": "2019-08-24T14:15:22Z",
  "is_active": true,
  "tags": [
    "string"
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Link not found",
    "details": {
      "fields": [
        {
          "field": "string",
          "message": "string"
        }
      ]
    }
  }
}
PATCH
/links/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

API key in format wl_live_xxx (production) or wl_test_xxx (test).

In: header

Path Parameters

id*string
Formatuuid

Request Body

application/json

destination_url?string
Formaturi
ios_url?|
Formaturi
ios_fallback_url?|
Formaturi
android_url?|
Formaturi
android_fallback_url?|
Formaturi
og_title?|
Lengthlength <= 255
og_description?|
og_image_url?|
Formaturi
tags?array<>|
Itemsitems <= 20
expires_at?|
Formatdate-time
password?|
app_id?|
Formatuuid

Response Body

application/json

application/json

application/json

curl -X PATCH "https://api.warplink.app/v1/links/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "short_url": "https://aplnk.to/abc123",
  "slug": "abc123",
  "domain": "aplnk.to",
  "destination_url": "http://example.com",
  "ios_url": "http://example.com",
  "ios_fallback_url": "http://example.com",
  "android_url": "http://example.com",
  "android_fallback_url": "http://example.com",
  "og_title": "string",
  "og_description": "string",
  "og_image_url": "http://example.com",
  "app_id": "affd1d10-9538-4fc8-9e0b-4594a28c1335",
  "expires_at": "2019-08-24T14:15:22Z",
  "is_active": true,
  "tags": [
    "string"
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Link not found",
    "details": {
      "fields": [
        {
          "field": "string",
          "message": "string"
        }
      ]
    }
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Link not found",
    "details": {
      "fields": [
        {
          "field": "string",
          "message": "string"
        }
      ]
    }
  }
}
DELETE
/links/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

API key in format wl_live_xxx (production) or wl_test_xxx (test).

In: header

Path Parameters

id*string
Formatuuid

Response Body

application/json

application/json

curl -X DELETE "https://api.warplink.app/v1/links/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "short_url": "https://aplnk.to/abc123",
  "slug": "abc123",
  "domain": "aplnk.to",
  "destination_url": "http://example.com",
  "ios_url": "http://example.com",
  "ios_fallback_url": "http://example.com",
  "android_url": "http://example.com",
  "android_fallback_url": "http://example.com",
  "og_title": "string",
  "og_description": "string",
  "og_image_url": "http://example.com",
  "app_id": "affd1d10-9538-4fc8-9e0b-4594a28c1335",
  "expires_at": "2019-08-24T14:15:22Z",
  "is_active": true,
  "tags": [
    "string"
  ],
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Link not found",
    "details": {
      "fields": [
        {
          "field": "string",
          "message": "string"
        }
      ]
    }
  }
}

API Overview

WarpLink REST API reference — authentication, rate limiting, and error handling.

Apps

Register and manage mobile apps for deep linking.

On this page

Create a LinkList LinksGet a LinkUpdate a LinkDelete a Link