Search

Note the API is currently in beta and is disabled by default. Breaking changes may occur as we finalise the functionality.
Contact us if you want to test the API and we'll turn it on for your account.

Querying

Passing the parameter q to the search API to perform a search. It supports the Lucene syntax

Search Overview

GET https://acme.minutebase.com/api/v1/search?q=:query

The overview search returns matches for every type of item we support searching. Pagination works if page is passed in, but the top level grouping will not include pagination details other than total_entries (they are included on the individual sets of results).

It's best to use a typeless search for an overview screen, then paginate individual sets of results.

Response

{
  :total_entries => 400,
  :people => {
    :per_page       => 25,
    :total_entries  => 16,
    :current_page   => 1,
    :total_pages    => 1,
    :results        => [ ... ]
  },
  :meetings => {
    :per_page       => 25,
    :total_entries  => 100,
    :current_page   => 1,
    :total_pages    => 4,
    :results        => [ ... ]
  }
  ...
}

Specific Type Search

GET https://acme.minutebase.com/api/v1/search/:type?q=:query

:type can be one of:

• people
• meetings
• minutes
• agenda_items
• documents

Response

This depends on the type of result you've specified. See the relevant sections of the API for each type (linked above) to see the attributes available for each set of results.

{
    :per_page       => 25,
    :total_entries  => 100,
    :current_page   => 1,
    :total_pages    => 4,
    :results        => [ ... ]
}