Get Officers

get

http://127.0.0.1:5001/api/v1/agencies/{agency_uid}/officers

Get a list of all of the officers who have been employed by a given agency.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

agency_uid

string

required

The uid of the agency you want to retrieve.

Query Params

page

integer

≥ 1

Defaults to 1

Page number

per_page

integer

1 to 100

Defaults to 20

Number of items per page

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.

name

string

Filter officers by their name. The value should be a string in the format "first middle last suffix".

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.

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

200A JSON array of officer objects

400Validation error

404Resource not found