added
New filters on /application_key_dates
June 12th, 2025
Added a compound filter filter[agency_key_date]
GET /application_key_dates to allow filtering on custom agency key date information.
improved
Updating Application Status Changes endpoint
June 5th, 2025
Added provider-external-identifier
as a field to the GET
response payloads for the application_status_changes
endpoints
2024 Changes
May 16th, 2025
- 2024-11-20: Added
is-estimated-dob
toPOST
andPUT
/children
endpoints, and toPOST
/social-connections
within theconnection-person
relationship. - 2024-11-20: Added
GET application-status-changes
endpoint. - 2024-09-25: Added 'form-version' to '/application-forms' to help track version changes.
- 2024-09-04: Added
email-addresses
toPOST /social-connections
andprimary-email-address
toGET /people
. - 2024-08-28: Added 'address' and 'mailing-address' to
applications
type. - 2024-08-21: Added document links to the
GET /applications/:application_id/documents
response body - 2024-08-07: Added
external_group_id
field to thechildren
type - 2024-08-07: Added
GET application_key_dates
andGET application_key_dates/{:application_key_date_id}
- 2024-07-10: Added
email
field to theagency-workers
type - 2024-07-10: Added
POST /family_finding_searches
andPOST /children/:child_id/relationships/family_finding_searches
endpoints for creating new Family Finding Searches. - 2024-07-02: Added
name
field to theGET /applications/:application_id/documents
response body - 2024-06-25: Added 'portal-self' and 'portal-relationships-dashboard' links to Children
- 2024-06-25: Added
GET /family_finding_searches
,GET /family_finding_searches/:family_finding_search_id
, andGET /children/:child_id/relationships/family_finding_searches
endpoints. - 2024-06-19: Added
/contact_logs
,/contact_logs/:id
, and/children/:child_id/relationships/contact_logs
GET
endpoints. - 2024-06-19: Added 'licenses' to 'case-notes' type
- 2024-06-19: Added 'protected-tribe' and 'protected-tribe-names' to 'user-agency-profiles' type
- 2024-06-19: Added
POST /social_connections
andPOST /children/:child_id/relationships/social_connections
endpoints for creating new Social Connections. - 2024-05-30: Added
/social_connections
,/social_connections/:social_connection_id
, and/children/:child_id/relationships/social_connections
GET
endpoints. - 2024-05-30: Added GET
/people
and GET/people/:id
endpoints - 2024-05-15: Added the ability to filter by
document_slug
on theGET /applications/:application_id/documents
endpoint. - 2024-05-01: Added
owner-agency-slug
to/applications
,/documents
, and/applications/:application_id/documents
GET
endpoints. - 2024-04-10: Added
provider-external-identifier
toagency-placements
- 2024-01-10: Updated docs to include all
relationships
forinitial-applications
andrenewal-applications
2023 Changes
May 16th, 2025
- 2023-12-05: Added ability to set applicant address information and lead source information via
POST /applications
endpoint. - 2023-10-04: Added new fields to
PUT /user_agency_profiles
to update demographic data. - 2023-10-04: Added the option to sort by
status_date
on ourGET /applications
endpoint. - 2023-09-20: Added new "Partner Agency Access" section to group endpoints avaliable for partner agencies to use.
- 2023-08-31: Updated "placement_providers" schema to include a reference to a provider's license(s). Added "application-type" to "application_template" schema
- 2023-07-27: Originally slated for 2022-01-07, the URL query parameter "api_token" is now officially deprecated and undocumented (but will continue to function for the foreseeable future.)
- 2023-07-12: Training Curriculums can now be listed via the
GET /training_curriculums
endpoint. - 2023-07-05: It is now possible to delete Worker Assignments on Applications via the
DELETE /worker_assignments/:worker_assignment_id
endpoint. - 2023-06-30: Placement Providers can now be listed via the
GET /placement_providers
endpoint. - 2023-06-21: Worker Assignments can now be created for arbitrary Applications.
- 2023-06-21: Worker Assignments can now be included when creating a new Application.
- 2023-05-19: GET /applications endpoints now return status override state, reason and explanation when present.
- 2023-05-19: Worker Assignments index can now be filtered by
created_start_date
andcreated_end_date
. - 2023-05-12: Agency-configured Application Templates are now enumerable via the
GET /application_templates
endpoint. - 2023-05-04: Added ability to associate and dissociate tags with Applications (Licenses) via
POST|DELETE /applications/:application_id/tags
. - 2023-05-04: Added the fields parental-rights-status and date-parental-rights-terminated to the child API.
- 2023-04-28: License payloads now include a
tag-summary
. - 2023-04-24: Added POST /background_check_logs and GET /background_check_log/:id endpoints.
- 2023-04-24: Agency-configured Tags are now enumerable via the
GET /tags
endpoint. - 2023-04-14: Added days-of-notice, placement-ended-reason-explanation, placement-ended-requester, and new options to placement-ended-reason to the placement periods API.
- 2023-04-11: The /placement-periods endpoints now return (and accept)
pre-adoption
as an optional boolean flag. - 2023-03-18: Added ability to assign workers to applications via POST /applications/:id/relationships/worker_assignments.
- 2023-03-15: Index and show endpoints can now make use of the
?included=a,b,c
query param to limit how much associated data is returned in the payload. Pass?included
with no arguments to exclude all associated data. For backwards compatibility, the default behavior when this query param is absent continues to be "include all available associations". These docs have been updated to include lists of available associations for each endpoint. - 2023-03-02: Added ability to set "recruiting" status on POST /applications.
- 2023-02-14: Added a new field "training-or-waiver-date" to /training_requirements body
- 2023-01-31: Added POST and PUT for /case-notes endpoint.
2022 Changes
May 16th, 2025
- 2022-12-30: Added ability to suppress Application welcome emails on POST /applications.
- 2022-12-20: Added placement holds as a relationship to agency placement endpoints
- 2022-11-17: Added a new top-level
meta:
key to collection endpoints that contains data such as total records, current page, number of pages, page size and current sorting params. - 2022-11-03: Updated /children and /placement-periods to require top level attributes in POST and PUT bodies. Adding POST /children endpoint.
- 2022-10-31: Added child-in-home to the agency-placement PUT endpoint.
- 2022-09-15: Added agency worker information to the data included in user-agency-profile GET payloads.
- 2022-09-09: Added ability to supply license external identifier via Application POST and PUT.
- 2022-09-01: Added expiry date to application endpoint.
- 2022-08-31: Added the ability get application form data via the API.
- 2022-08-09: Added the fields gender-expression and sexual-orientation to the child API.
- 2022-07-14: Added the ability to filter agency placements with/without placement holds.
- 2022-07-11: Added the ability to fetch training requirements via the API.
- 2022-07-05: Added the ability to fetch case notes via the API.
- 2022-06-30: Added the ability to create and update placement holds for a specific agency placement.
- 2022-05-26: Added the ability to get placement holds for a specific agency placement.
- 2022-04-22: Added the ability to look up agency placements via the API.
- 2022-01-07: Planned date for deprecating support for query parameter "api_token". Concurrently supporting Authorization Header with "Bearer {api_token}"
2021 Changes
May 16th, 2025
- 2021-11-19: Deprecation date for therapeutic_care boolean in the Children endpoint response.
- 2021-09-10: Added backwards compatible feature to split full name into
first name, middle name, and last name for families for Applications and
User Agency Profiles endpoints. - 2021-07-26: Added the ability to intake applications via the API.
- 2021-07-08: Improved documentation for paginating collections in the API.
- 2021-07-05: Added the field ethnicities_array to the child API.
- 2021-07-01: Fix: Reference documents now have slugs (they previously were null).
- 2021-06-21: Added tz=utc query parameter to return UTC timezone timestamp.
- 2021-06-10: Added the ability to update applications via the API.
- 2021-05-13: Added the field how-did-you-hear-about-us-label to the applications API.
- 2021-05-06: Added the field medically-trained to the applications API.
- 2021-04-14: Added the fields capacity, approved-age-lower,
approved-age-higher, community-foster, and respite-provider
to the applications API.