Researcher Documentation

Welcome to the researcherdocs developer hub. You'll find comprehensive guides and documentation to help you start working with researcherdocs as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started

Filtering Programs

You can use filters to find programs that match a particular set of criteria, such as ones that are high in rewards, have recently started or have recently been updated.

To sort through the many programs Bugcrowd offers, you can create a query using filter keys.

Filter Keys

Filter keys narrow programs down to a specific set of results.
The following filter keys and possible values are available:

Key
Value
Notes

accepted-invite

true or false

Filters to show programs with accepted invitations

end

YYYY-MM-DD,
<=YYYY-MM-DD,
or >=YYYY-MM-DD

Filters by program's end date

following

true or false

Filters to show programs you have subscribed to, for program updates

participant

true or false

Filters to show programs you have submitted to previously

participation

private or public

Filters to show Public or private programs, respectively

pending-invite

true or false

Filters to show programs you have pending invitations for

points-only

true or false

Filters to show lack of or presence of monetary rewards

promoted

YYYY-MM-DD,
<=YYYY-MM-DD,
or >=YYYY-MM-DD

Filters by promoted date

rewards-max

= (equal to),
<= (less than or equal to),
or >= (greater than or equal to)

Filters by max reward for the programs

rewards-min

= (equal to),
<= (less than or equal to),
or >= (greater than or equal to)

Filters by min reward for the programs

sort

YYYY-MM-DD,
<= YYYY-MM-DD,
or >=YYYY-MM-DD

Order in which to display submissions

starts

YYYY-MM-DD,
<=YYYY-MM-DD,
or >=YYYY-MM-DD

Filter by program's start date

status

closed or live

Filter by program's current status

safe-harbor

'full' or 'partial'

Filter by program's adoption of disclose.io "Safe Harbor" requirements

Filter Syntax

To create a query, you need to use the following syntax: <filter key>:<value>.

Make sure you include a colon after the filter key and do not include any spaces between the filter key and value.

You can enter multiple filter key/value pairs in the query, such as: status:live rewards-p1-max:>2.

By default, the query includes sort:promoted-desc, which sorts your programs in descending order based on the dates they were promoted.

Filter Logic

There is an AND operator between unique filter keys; however, multiple instances of the same filter key use the OR operator.

For example, status:live status:closed participation:private returns all private programs that are live or closed.

Building a Query

To help you build a programs query, a list of available filter keys **will appear when you click in the search field. After you select a filter key, the search field will show you possible values based on what you've selected.

Remember:

  • You can use as many key/value combinations you need
  • The AND operator (for unique filter keys) and the OR operator (between multiple instances of the same filter key) automatically apply, you do not need to write them into the search bar.
  • As you add filter key/value pairs to the query, the results automatically refresh to show you the latest results.

Note:

If you input an invalid filter key or query, no programs will be returned. Please review your queries for any errors if the results do not show the programs you expect to see.

Filtering Programs


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.