List offers

​

Lists offers with pagination and optional filtering/ordering.

Note: The type query parameter is required.

Query Parameters
  • type
    Type: stringenum
    required

    Filter offers by type.

    values
    • banner
    • sale
  • page
    Type: integer
    min:  
    1

    The result page number to fetch. The first page has number 1.

  • page_size
    Type: integer
    min:  
    1
    max:  
    100

    How many results to return per page.

  • filter_type
    Type: stringenum

    Type of filtering to perform.

    values
    • field
    • field-prefix
    • field-search
  • filter_field
    Type: string

    Field to filter on. Searchable fields include offer_id and title.

  • filter_value
    Type: string

    Value to filter by.

  • order_field
    Type: string

    Field to order results by. Orderable fields include offer_id and title.

  • order_direction
    Type: stringenum

    Direction to order results.

    values
    • asc
    • desc
Responses
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/offer
curl 'https://sandbox.billogram.com/api/v2/offer?type=banner&page=1&page_size=25&filter_type=field&filter_field=&filter_value=&order_field=&order_direction=asc' \
  --header 'Authorization: Basic username:password'

{
  "status": "OK",
  "data": [
    {
      "offer_id": "banner001",
      "type": "banner",
      "title": "string",
      "text": "string",
      "media": {
        "picture": "string",
        "picture_type": "image/png"
      },
      "link_text": "string",
      "created_at": "2026-04-29T11:19:15.647Z",
      "updated_at": "2026-04-29T11:19:15.647Z",
      "info_link": "string"
    }
  ],
  "meta": {
    "total_count": 1
  }
}

Offer list response