List Branded Domains

curl --request GET \
  --url https://jmpy.me/api/v1/domains/branded \
  --header 'Authorization: Bearer <token>'

{
  "domains": [
    {
      "id": "<string>",
      "domain": "<string>",
      "name": "<string>",
      "description": "<string>",
      "is_verified": true,
      "is_txt_verified": true,
      "is_dedicated": true,
      "created_at": "<string>"
    }
  ],
  "total": 123
}

GET

domains

branded

List Branded Domains

curl --request GET \
  --url https://jmpy.me/api/v1/domains/branded \
  --header 'Authorization: Bearer <token>'

{
  "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

domains

array

Array of branded domains.

Show Branded Domain Object

string

Unique identifier (UUID).

domain

string

The registered domain name.

name

string

Display name for the domain.

description

string

Description of the domain.

is_verified

boolean

Whether the domain is verified (DNS A/CNAME record).

is_txt_verified

boolean

Whether domain ownership is verified via TXT record.

is_dedicated

boolean

Whether it is a dedicated domain.

created_at

string

ISO 8601 creation timestamp.

total

integer

Total number of branded domains.

Request Examples

curl -X GET "https://jmpy.me/api/v1/domains/branded" \
  -H "Authorization: Bearer YOUR_API_KEY"

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);

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);

import requests

response = requests.get(
    'https://jmpy.me/api/v1/domains/branded',
    headers={'Authorization': 'Bearer YOUR_API_KEY'}
)
print(response.json())

<?php
$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://jmpy.me/api/v1/domains/branded', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY'
    ]
]);
?>

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)
}

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

{
  "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

Get only the domains that are verified and ready for use.

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

Locate a specific domain ID by its name.

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;
}

Create Branded Domain

Verify Domain

Verify DNS settings for a domain

Delete Domain

Remove a branded domain

Create Short URL

Create links on your branded domain

List Subdomains Create Subdomain

​Response

​Request Examples

​Response Examples

​Use Cases

​Related Endpoints

Create Branded Domain

Verify Domain

Delete Domain

Create Short URL

Response

Request Examples

Response Examples

Use Cases

Related Endpoints