Get All Custom adv

This endpoint retrieves all custom adv.

info

This operation requires authentication only if content_availability community option is false.

This operation requires custom_adv_enabled community option set to true.

If custom_adv_only_for_anonymous_users_enabled community option is set to true the results will be returned only for anonymous users.

If the user is administrator or editor all adv (active or not) are returned, while only the active ones are returned if the user is normal

HTTP Request

GET /api/v2/custom_adv/

Parameters

Name	In	Type	Required	Description
limit	query	integer	false	Number of results to return per page.
offset	query	integer	false	The initial index from which to return the results.
position	query	string	false	Filter using field position.
category	query	string	false	Filter using field category.
active	query	string	false	Filter using field active (only if user is administrator or editor)
search	query	string	false	A search term.

Example Request

JavaScript

const headers = {
  'Accept':'application/json',
  'Authorization': 'Bearer {access_token}'
};

fetch('/api/v2/custom_adv/',
{
  method: 'GET',
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

Bash

# You can also use wget
curl -X GET /api/v2/custom_adv/ \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access_token}'

Responses

Status	Meaning	Description	Schema
200	OK	Response status code	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» count	integer	false	none	Total results count
» next	string(uri)¦null	false	none	Next page url
» previous	string(uri)¦null	false	none	Previous page url
» results	list(Custom Adv)	false	none	List of results

Example responses

200

{
  "count": "integer",
  "next": "string(uri)",
  "previous": "string(uri)",
  "results": [ 
    {
      "id": "integer",
      "position": "string",
      "title": "string",
      "link": "string(uri)",
      "image": "string",
      "embed_code": "string",
      "active": "boolean",
      "created_at": "string",
      "lastmod_datetime": "string",
      "category": "integer",
      "created_by": "integer"
    }
  ]
}