List ads for a company

Lists all ads for a company, optionally searched, filtered, sorted and paginated. The full count matching the search and the filter (before pagination) is returned in the X-Total-Count response header.

GET/v1/hq/companies/{company_id}/ads

Authorization

AuthorizationBearer <token>

The Noona HQ API uses Bearer token for authentication.

Endpoints that return generic information that does not contain sensitive data do not require authentication. Endpoints that require authentication are specifically marked in the documentation.

Authorization: Bearer your-token

In: header

Path Parameters

company_id*string

Query Parameters

filter?

sort?

Sorting

pagination?

Pagination

search?string

Finds ads by name and by the overlay text of a text-overlay creative (case-insensitive partial match). Every word in the term has to appear in one of those two fields, but the words can be in any order, so midweek offer also finds an ad called Offer for midweek. Applies alongside filter, not instead of it, and X-Total-Count is the number of ads left after both.

Example"midweek offer"

select?array<string>

Field Selector

expand?array<string>

Expandable attributes

Response Body

application/json

curl -X GET "https://api.noona.is/v1/hq/companies/string/ads"

curl -X GET "https://api.noona.is/v1/hq/companies/string/ads"

[
  {
    "id": "string",
    "company": "string",
    "name": "string",
    "status": "draft",
    "campaign_count": 2,
    "creative": {
      "type": "image",
      "image": {
        "thumb": "https://placekitten.com/200/200",
        "image": "https://placekitten.com/200/300",
        "public_id": "https://placekitten.com/200/300",
        "type": "thumbnail",
        "provider": "cloudinary",
        "width": 200,
        "height": 300,
        "bytes": 95849
      }
    },
    "description": "string",
    "language": "string",
    "placement": {
      "type": "discovery",
      "discovery": {
        "ad_placement": "string"
      }
    },
    "action": {
      "type": "company",
      "event_type": "string",
      "voucher_template": "string",
      "scheduled_event": "string"
    },
    "rejection_reason": "string",
    "submitted_at": "2019-08-24T14:15:22Z",
    "reviewed_at": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
]

Empty