List placement periods

List placement periods

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

How many results to retrieve. For performance reasons, collections do not return all the results at once; results are returned in a paginated fashion. If this parameter is omitted, the default page size is 20 results.

string

Which page of results to retrieve, starting with 1. If this collection has more results than page[size], subsequent requests with increasing page[number] will be necessary if you want to exhaust all results for this request.

string

Comma-separated list of associations to bundle in the included section of the response payload. To exclude all possible associations, provide the param but no argument.

Available values : *, "", respite-receiver

string
enum

Sort the results by various fields. The prefix - sorts results in descending order; no prefix sorts results in ascending order.

Allowed:
string

The starting date of the range of placements to return

string

The ending date of the range of placements to return

string

The ID of the associated AgencyPlacement

string

The ID of the associated child for the placement

string
enum

The type of placement

string
enum

The type of placement

string

Filter placements by their agency placement external identifier

string

Filter placements by their child external identifier

string

Filter placements by their placement period external identifier

string
enum
required

By default, the API returns Pacific time zone timestamps. This behavior will be deprecated. Please append tz=utc on all requests to ensure your system always receives UTC timezone values from the API.

Allowed:
Response

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json