Get domains

Get domains

get

Query parameters

Typestring · enumOptional

JFramework supports multiple domain types, each designed for a specific use case

Possible values:

Protocolstring · enumOptional

The protocol of the domain.

Possible values:

DomainstringOptional

The domain name.

KeywordsstringOptional

The keywords of the domain.

VerifiedbooleanOptional

Filter by the verified domain.

IsDefaultbooleanOptional

Filter by the default domain.

IsPrimarybooleanOptional

Filter by the primary domain.

SortDataFieldstringOptional

The sort data field to sort. By default, the value is ID.

SortOrderstring · enumOptional

Specifies the sorting order type for a collection.

Possible values:

PageNumberinteger · int32Optional

The page number of the pagination. Default value is 0.

PageSizeinteger · int32Optional

The page size of the pagination. Default value is 200.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Responses

200

The request was successful.

application/json

This provides interfaces for API responses with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Read-onlyRequired

This is the message to be displayed to the user.

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

get

/api/v1/domains

HTTPcURLJavaScriptPython

GET /api/v1/domains HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "items": [
      {
        "dnsRecords": [],
        "id": "sApKpllz4sAplsmzha",
        "type": "Client",
        "protocol": "Https",
        "domain": "example.yourdomain.com",
        "verified": true,
        "verifiedDate": "2026-01-26T01:03:23.757334Z",
        "isDefault": true,
        "isPrimary": true
      }
    ],
    "totalItems": 1,
    "pageNumber": null,
    "pageSize": null
  },
  "errors": []
}