Gets an ad

Get an ad.

get

Path parameters

idstringRequired

The id of the ads.

Header parameters

Brand-URLstringRequired

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

Example: YOUR_BRAND_URL

Auth-KeystringRequired

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

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

HTTPcURLJavaScriptPython

GET /api/v1/ads/{id} HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "domains": [
      {
        "dnsRecords": [],
        "id": "sApKpllz4sAplsmzha",
        "type": "Client",
        "protocol": "Https",
        "domain": "example.yourdomain.com",
        "verified": true,
        "verifiedDate": "2025-09-12T08:18:49.545692Z",
        "isDefault": true,
        "isPrimary": true
      }
    ],
    "type": "Image",
    "title": "Summer Sale",
    "position": "homepage-top",
    "targetURL": "https://example.com/summer-sale",
    "description": "Up to 50% off during our summer sale!",
    "tags": null,
    "startDate": "2025-07-20T00:00:00",
    "endDate": "2025-10-20T23:59:59",
    "metadata": null,
    "languageCodes": [
      "en",
      "cn"
    ],
    "countryCodes": [
      "US",
      "SG"
    ],
    "status": "Active",
    "images": [
      {
        "id": "sApKpllz4sAplsmzha",
        "user": {
          "id": "Plamxinzg18snza",
          "code": "EXAMPLE",
          "avatar": "https://www.gravatar.com/avatar/205e460b479e2e5b48aec07710c08d50",
          "packageId": "1Plamxinzg18snza",
          "packageCode": "PACKAGE",
          "emailAddress": "[email protected]",
          "phoneNumber": "[phone]",
          "nickName": "example",
          "roles": [
            "admin",
            "support"
          ]
        },
        "refObject": "Object",
        "refId": 1,
        "mimeType": "image/png",
        "fileURL": "https://cdn.jframework.io/uploads/documents/example.pdf",
        "originalFilename": "image.png",
        "fileSize": 1028,
        "notes": "Notes",
        "tags": "Tags",
        "zOrder": 1,
        "isSystem": false,
        "createdDate": "2025-09-12T15:18:49.54569+07:00"
      }
    ],
    "id": "sApKpllz4sAplsmzha",
    "createdDate": "2025-09-12T08:18:49.54569Z"
  },
  "errors": []
}