Gets ads

Get ads.

get

Query parameters

Typestring · enumOptional

Provide the type of the ads.

Possible values:

TitlestringOptional

The title to filter.

PositionstringOptional

The position to filter.

TargetURLstringOptional

The target URL to filter.

DescriptionstringOptional

The description to filter.

TagsstringOptional

The tags to filter.

Statusstring · enumOptional

Provide the status of the ads

Possible values:

KeywordsstringOptional

The keywords to filter.

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

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

The API result model 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: 1Required

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/ads

HTTPcURLJavaScriptPython

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

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "items": [
      {
        "domains": [
          {
            "dnsRecords": [],
            "id": "sApKpllz4sAplsmzha",
            "type": "Client",
            "protocol": "Https",
            "domain": "example.yourdomain.com",
            "verified": true,
            "verifiedDate": "2026-01-26T01:03:23.547821Z",
            "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": "[e-mail]",
              "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": "2026-01-26T08:03:23.547759+07:00"
          }
        ],
        "id": "sApKpllz4sAplsmzha",
        "createdDate": "2026-01-26T01:03:23.547746Z"
      }
    ],
    "totalItems": 1,
    "pageNumber": 0,
    "pageSize": 20
  },
  "errors": []
}