Search an Embed

This endpoint performs search to Embeds

info

This operation requires authentication only if content_availability community option is false

HTTP Request

GET /api/v2/embed/search/

Parameters

Name	In	Type	Required	Description
embed_type	query	string	false	embed_type
embed_id	query	string	false	embed_id
limit	query	integer	false	Number of results to return per page
offset	query	integer	false	The initial index from which to return the results

Example Request

JavaScript

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

fetch('/api/v2/embed/search/',
{
  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/embed/search/ \
  -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(Embed)	false	none	List of results

Example responses

200

{
  "count": "integer",
  "next": "string(uri)",
  "previous": "string(uri)",
  "results": [
    {
      "id": "integer",
      "embed_type": "string",
      "embed_id": "string",
      "url": "string(uri)",
      "metadata": {}
    }
  ]
}