List Placements

The List method uses GET to return a list of placements in the current network.

The List method is a case-sensitive query to find the prefix of any words in the name. For example, queries with the following conditions will return an agency with the name “This is a placement”:

  • “?name=This”

  • “?name=this”

  • “?name=place” Queries with the following conditions will not return the above placement:

  • “?name=lace” (no words start with “lace”, though it is part of “Placement”).

Examples to list Placements by various start dates by passing start_date as a URL query parameter:

  • “?start_date=2016-01-01..2017-01-01” will list all Placements that began between 2016-01-01 and 2017-01-01

  • “?start_date=..2017-01-01T14:30:14Z” will list all Placements that began before 2017-01-01T14:30:14Z

  • “?start_date=2017-01-01T14:30:14Z..” will list all Placements that began after 2017-01-01T14:30:14Z

Dates are formatted according to ISO8601, UTC

The List method uses GET to return a list of placements in the current network.

The List method is a case-sensitive query to find the prefix of any words in the name. For example, queries with the following conditions will return an agency with the name “This is a placement”:

“?name=This”

“?name=this”

“?name=place” Queries with the following conditions will not return the above placement:

“?name=lace” (no words start with “lace”, though it is part of “Placement”).

Examples to list Placements by various start dates by passing start_date as a URL query parameter:

“?start_date=2016-01-01..2017-01-01” will list all Placements that began between 2016-01-01 and 2017-01-01

“?start_date=..2017-01-01T14:30:14Z” will list all Placements that began before 2017-01-01T14:30:14Z

“?start_date=2017-01-01T14:30:14Z..” will list all Placements that began after 2017-01-01T14:30:14Z

Dates are formatted according to ISO8601, UTC

Language
Credentials
Header
Click Try It! to start a request and see the response here!