Get officers

get

http://127.0.0.1:5001/api/v1/officers

Returns a list of officer. A number of simple filters can be applied to limit the results. If no filters are applied, a random sample of officers will be returned.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

integer

≥ 1

Defaults to 1

Page number

per_page

integer

1 to 100

Defaults to 20

Number of items per page

query

string

A general search query to filter officers with. This will search across first, middle, and last names.

first_name

string

Filter officers by their first name. The value should be a string.

middle_name

string

Filter officers by their middle name. The value should be a string.

last_name

string

Filter officers by their last name. The value should be a string.

suffix

string

Filter officers by their namesuffix. The value should be a string.

active_after

date

Filter officers who were active after this date. The date should be in the format YYYY-MM-DD.

active_before

date

Filter officers who were active before this date. The date should be in the format YYYY-MM-DD.

agency

string

Filter officers by the agency they are employed by. The value should be a comma-separated list of agency uids.

rank

string

Filter officers by their rank. The value should be a comma-separated list of ranks.

unit

string

Filter officers by their unit. The value should be a comma-separated list of unit uids.

ethnicity

string

Filter officers by their ethnicity. The value should be a comma-separated list of ethnicities.

badge_number

string

Filter officers by their badge number. The value should be a comma-separated list of badge numbers.

search_result

boolean

Set as true to return officers in a search result format, which includes highlights and relevance scores.

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful operation

401Unauthorized