API Reference
Apps
Register and manage mobile apps for deep linking.
Create an App
POST/apps
Create an app
Request Body
| Field | Type | Description |
|---|
name* | string | |
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 | |
ios_universal_link_paths | string[] | |
android_package_name | string | Java package name, e.g. com.example.myapp |
android_sha256_fingerprints | string[] | |
android_play_store_url | string | |
android_app_links_paths | string[] | |
Responses
201App created
| Field | Type | Description |
|---|
id | string | |
org_id | string | |
name | string | |
ios_bundle_id | string | null | |
ios_team_id | string | null | |
ios_app_store_id | string | null | |
ios_app_store_url | string | null | |
ios_universal_link_paths | array | null | |
android_package_name | string | null | |
android_sha256_fingerprints | array | null | |
android_play_store_url | string | null | |
android_app_links_paths | array | null | |
created_at | string | |
updated_at | string | |
400Validation error
| Field | Type | Description |
|---|
error* | object | |
409Duplicate bundle ID or package name
| Field | Type | Description |
|---|
error* | object | |
List Apps
GET/apps
List apps
Parameters
| Name | Type | In | Description |
|---|
limit | integer | query | |
offset | integer | query | |
search | string | query | |
Responses
200List of apps
| Field | Type | Description |
|---|
data | object[] | |
pagination | object | |
Get an App
GET/apps/{id}
Get an app
Parameters
| Name | Type | In | Description |
|---|
id* | string | path | |
Responses
200App details
| Field | Type | Description |
|---|
id | string | |
org_id | string | |
name | string | |
ios_bundle_id | string | null | |
ios_team_id | string | null | |
ios_app_store_id | string | null | |
ios_app_store_url | string | null | |
ios_universal_link_paths | array | null | |
android_package_name | string | null | |
android_sha256_fingerprints | array | null | |
android_play_store_url | string | null | |
android_app_links_paths | array | null | |
created_at | string | |
updated_at | string | |
404Not found
| Field | Type | Description |
|---|
error* | object | |
Update an App
PATCH/apps/{id}
Update an app
Parameters
| Name | Type | In | Description |
|---|
id* | string | path | |
Request Body
| Field | Type | Description |
|---|
name | string | |
ios_bundle_id | string | null | |
ios_team_id | string | null | |
ios_app_store_id | string | null | |
ios_app_store_url | string | null | |
ios_universal_link_paths | array | null | |
android_package_name | string | null | |
android_sha256_fingerprints | array | null | |
android_play_store_url | string | null | |
android_app_links_paths | array | null | |
Responses
200Updated app
| Field | Type | Description |
|---|
id | string | |
org_id | string | |
name | string | |
ios_bundle_id | string | null | |
ios_team_id | string | null | |
ios_app_store_id | string | null | |
ios_app_store_url | string | null | |
ios_universal_link_paths | array | null | |
android_package_name | string | null | |
android_sha256_fingerprints | array | null | |
android_play_store_url | string | null | |
android_app_links_paths | array | null | |
created_at | string | |
updated_at | string | |
400Validation error
| Field | Type | Description |
|---|
error* | object | |
404Not found
| Field | Type | Description |
|---|
error* | object | |
409Duplicate
| Field | Type | Description |
|---|
error* | object | |
Delete an App
DELETE/apps/{id}
Delete an app
Parameters
| Name | Type | In | Description |
|---|
id* | string | path | |
Responses
200Deleted app
| Field | Type | Description |
|---|
id | string | |
org_id | string | |
name | string | |
ios_bundle_id | string | null | |
ios_team_id | string | null | |
ios_app_store_id | string | null | |
ios_app_store_url | string | null | |
ios_universal_link_paths | array | null | |
android_package_name | string | null | |
android_sha256_fingerprints | array | null | |
android_play_store_url | string | null | |
android_app_links_paths | array | null | |
created_at | string | |
updated_at | string | |
404Not found
| Field | Type | Description |
|---|
error* | object | |