API Reference
Short URLs
Custom Aliases
QR Codes
Domains
Short URL Analytics
QR Code Analytics
Short URL A/B Testing
List Branded Domains
Copy
curl --request GET \
--url https://jmpy.me/api/v1/domains/branded \
--header 'Authorization: Bearer <token>'Copy
{
"domains": [
{
"id": "<string>",
"domain": "<string>",
"name": "<string>",
"description": "<string>",
"is_verified": true,
"is_txt_verified": true,
"is_dedicated": true,
"created_at": "<string>"
}
],
"total": 123
}Domains
List Branded Domains
List your custom branded domains
GET
https://jmpy.me/api/v1
/
domains
/
branded
List Branded Domains
Copy
curl --request GET \
--url https://jmpy.me/api/v1/domains/branded \
--header 'Authorization: Bearer <token>'Copy
{
"domains": [
{
"id": "<string>",
"domain": "<string>",
"name": "<string>",
"description": "<string>",
"is_verified": true,
"is_txt_verified": true,
"is_dedicated": true,
"created_at": "<string>"
}
],
"total": 123
}Retrieve a list of all branded domains registered to your account. Branded domains are custom domains (e.g.,
go.mycompany.com) that you have configured to use with Jmpy.me.
Response
Array of branded domains.
Show Branded Domain Object
Show Branded Domain Object
Unique identifier (UUID).
The registered domain name.
Display name for the domain.
Description of the domain.
Whether the domain is verified (DNS A/CNAME record).
Whether domain ownership is verified via TXT record.
Whether it is a dedicated domain.
ISO 8601 creation timestamp.
Total number of branded domains.
Request Examples
- cURL
- Node.js
- TypeScript
- Python
- PHP
- Go
- Java
Copy
curl -X GET "https://jmpy.me/api/v1/domains/branded" \
-H "Authorization: Bearer YOUR_API_KEY"
Copy
const fetch = require('node-fetch');
const response = await fetch('https://jmpy.me/api/v1/domains/branded', {
headers: { 'Authorization': 'Bearer YOUR_API_KEY' }
});
const data = await response.json();
console.log(data);
Copy
import axios from 'axios';
const response = await axios.get(
'https://jmpy.me/api/v1/domains/branded',
{ headers: { 'Authorization': 'Bearer YOUR_API_KEY' } }
);
console.log(response.data);
Copy
import requests
response = requests.get(
'https://jmpy.me/api/v1/domains/branded',
headers={'Authorization': 'Bearer YOUR_API_KEY'}
)
print(response.json())
Copy
<?php
$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://jmpy.me/api/v1/domains/branded', [
'headers' => [
'Authorization' => 'Bearer YOUR_API_KEY'
]
]);
?>
Copy
package main
import (
"net/http"
)
func main() {
url := "https://jmpy.me/api/v1/domains/branded"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer YOUR_API_KEY")
http.DefaultClient.Do(req)
}
Copy
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.URI;
import java.net.http.HttpResponse;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://jmpy.me/api/v1/domains/branded"))
.header("Authorization", "Bearer YOUR_API_KEY")
.GET()
.build();
client.send(request, HttpResponse.BodyHandlers.ofString());
Response Examples
- 200 OK
Copy
{
"success": true,
"data": {
"domains": [
{
"id": "uuid-string",
"domain": "go.acme.com",
"name": "Acme Links",
"description": "Main marketing links",
"is_verified": true,
"is_txt_verified": true,
"is_dedicated": false,
"created_at": "2024-01-01T00:00:00Z"
}
],
"total": 1
}
}
Use Cases
Filter verified domains
Filter verified domains
Get only the domains that are verified and ready for use.
Copy
async function getActiveDomains() {
const response = await fetch(
'https://jmpy.me/api/v1/domains/branded',
{ headers: { 'Authorization': 'Bearer YOUR_API_KEY' } }
);
const output = await response.json();
// Filter list client-side
const activeDomains = output.data.domains.filter(d => d.is_verified);
return activeDomains;
}
Find by name
Find by name
Locate a specific domain ID by its name.
Copy
async function findDomainId(domainName) {
const response = await fetch(
'https://jmpy.me/api/v1/domains/branded',
{ headers: { 'Authorization': 'Bearer YOUR_API_KEY' } }
);
const result = await response.json();
const domain = result.data.domains.find(d =>
d.domain.toLowerCase() === domainName.toLowerCase()
);
return domain ? domain.id : null;
}
Related Endpoints
⌘I