WarpLink
API Reference

Apps

Register and manage mobile apps for deep linking.

Create an App

POST
/apps

Authorization

bearerAuth
AuthorizationBearer <token>

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

In: header

Request Body

application/json

name*string
Length1 <= length <= 255
ios_bundle_id?string

Reverse-domain notation, e.g. com.example.myapp

ios_team_id?string

Apple Team ID, e.g. ABCDE12345

ios_app_store_id?string

Numeric App Store ID

ios_app_store_url?string
Formaturi
ios_universal_link_paths?array<>
android_package_name?string

Java package name, e.g. com.example.myapp

android_sha256_fingerprints?array<>
android_play_store_url?string
Formaturi
android_app_links_paths?array<>

Response Body

application/json

application/json

application/json

curl -X POST "https://api.warplink.app/v1/apps" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",
  "name": "string",
  "ios_bundle_id": "string",
  "ios_team_id": "string",
  "ios_app_store_id": "string",
  "ios_app_store_url": "http://example.com",
  "ios_universal_link_paths": [
    "string"
  ],
  "android_package_name": "string",
  "android_sha256_fingerprints": [
    "string"
  ],
  "android_play_store_url": "http://example.com",
  "android_app_links_paths": [
    "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"
        }
      ]
    }
  }
}

List Apps

GET
/apps

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
search?string
Lengthlength <= 200

Response Body

application/json

curl -X GET "https://api.warplink.app/v1/apps"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",
      "name": "string",
      "ios_bundle_id": "string",
      "ios_team_id": "string",
      "ios_app_store_id": "string",
      "ios_app_store_url": "http://example.com",
      "ios_universal_link_paths": [
        "string"
      ],
      "android_package_name": "string",
      "android_sha256_fingerprints": [
        "string"
      ],
      "android_play_store_url": "http://example.com",
      "android_app_links_paths": [
        "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
  }
}

Get an App

GET
/apps/{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/apps/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",
  "name": "string",
  "ios_bundle_id": "string",
  "ios_team_id": "string",
  "ios_app_store_id": "string",
  "ios_app_store_url": "http://example.com",
  "ios_universal_link_paths": [
    "string"
  ],
  "android_package_name": "string",
  "android_sha256_fingerprints": [
    "string"
  ],
  "android_play_store_url": "http://example.com",
  "android_app_links_paths": [
    "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"
        }
      ]
    }
  }
}

Update an App

PATCH
/apps/{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

name?string
Length1 <= length <= 255
ios_bundle_id?|
ios_team_id?|
ios_app_store_id?|
ios_app_store_url?|
Formaturi
ios_universal_link_paths?array<>|
android_package_name?|
android_sha256_fingerprints?array<>|
android_play_store_url?|
Formaturi
android_app_links_paths?array<>|

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "https://api.warplink.app/v1/apps/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",
  "name": "string",
  "ios_bundle_id": "string",
  "ios_team_id": "string",
  "ios_app_store_id": "string",
  "ios_app_store_url": "http://example.com",
  "ios_universal_link_paths": [
    "string"
  ],
  "android_package_name": "string",
  "android_sha256_fingerprints": [
    "string"
  ],
  "android_play_store_url": "http://example.com",
  "android_app_links_paths": [
    "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"
        }
      ]
    }
  }
}

Delete an App

DELETE
/apps/{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/apps/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",
  "name": "string",
  "ios_bundle_id": "string",
  "ios_team_id": "string",
  "ios_app_store_id": "string",
  "ios_app_store_url": "http://example.com",
  "ios_universal_link_paths": [
    "string"
  ],
  "android_package_name": "string",
  "android_sha256_fingerprints": [
    "string"
  ],
  "android_play_store_url": "http://example.com",
  "android_app_links_paths": [
    "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"
        }
      ]
    }
  }
}

Links

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

API Keys

Create and manage API keys for authentication.

On this page

Create an AppList AppsGet an AppUpdate an AppDelete an App