GET /v3/search

Search provides access the combined search index for different types of CEO items.

There are 4 different search types:

  • content
  • user
  • author
  • tag

Acl Action: SEARCH get

Arguments:

  • type - string: REQUIRED, should be 'content'
  • keywords - string: Search term.
  • tag - string: Filter by tag.
  • author - string: Filter by author.
  • filters[attachment_type] - string: Attachment type ('image', 'audio', 'youtube', etc).
  • filters[attachment_name] - string: Attachment file name.
  • filters[content_type] - string: Content type ('article', 'post', 'page', etc).
  • has_attachment - boolean: 1 for items with attachment, 0 for items without.
  • page - integer: Page number for paginated results.
  • per_page - int: Per page offset for pagination.
  • order - string: Valid property to order by. Will default to modified_at.
  • dir - string: Either asc or desc.

Example Response: See GET /v3/content

Arguments:

  • type - string: REQUIRED, should be 'user'
  • keyword - string: Search term.
  • includesnw - boolean: 1 to include SNworks users. Defaults to 0.
  • page - integer: Page number for paginated results.
  • per_page - int: Per page offset for pagination.
  • order - string: Valid property to order by. Will default to name.
  • dir - string: Either asc or desc.

Example Response: See GET /v3/user

Arguments:

  • type - string: REQUIRED, should be 'tag'
  • keyword - string: Search term. Must be at least 3 characters.
  • page - integer: Page number for paginated results.
  • per_page - int: Per page offset for pagination.
  • order - string: Valid property to order by. Will default to name.
  • dir - string: Either asc or desc.

Example Response: See GET /v3/tag

Arguments:

  • type - string: REQUIRED, should be 'author'
  • keyword - string: Search term. Must be at least 3 characters.
  • page - integer: Page number for paginated results.
  • per_page - int: Per page offset for pagination.
  • order - string: Valid property to order by. Will default to name.
  • dir - string: Either asc or desc.

Example Response: See GET /v3/author