Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

The Administration for Children and Families

The Administration for Children and Families v1 API

The v1 API from The Administration for Children and Families — 35 operation(s) for v1.

Documentation Provider Profile APIs.io OpenAPI GitHub

The Administration for Children and Families v1 API is one of 6 APIs that The Administration for Children and Families publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include v1. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 47 operations across 35 paths, and defines 17 schemas. It is described by OpenAPI 2.0, at version v1.

Requests are made against the base URL https://tanfdata.acf.hhs.gov/.

47 operations 35 paths 17 schemas 1 DELETE32 GET4 PATCH8 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
v1
Base URL
https://tanfdata.acf.hhs.gov/
Authentication
basic
Contact
tanfdata@acf.hhs.gov
Resource Areas
1

Authentication & Security 1

The Administration for Children and Families v1 API declares 1 security scheme for authenticating requests. It defines a basic scheme (Basic). By default, every request must be authenticated.

Paths & Operations 47

Across 35 paths, the API surfaces 47 operations — 1 DELETE, 32 GET, 4 PATCH, 8 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

v1 47
GET
/v1/auth_check
Handle get request and verify user is authorized.
v1_auth_check_list → 200
GET
/v1/change-request-logs/
ViewSet for change request audit logs.
v1_change-request-logs_list 1 param → 200
GET
/v1/change-request-logs/{id}/
ViewSet for change request audit logs.
v1_change-request-logs_read 1 param → 200
GET
/v1/change-requests/
ViewSet for user change requests.
v1_change-requests_list 1 param → 200
GET
/v1/change-requests/{id}/
ViewSet for user change requests.
v1_change-requests_read 1 param → 200
GET
/v1/data_files/
Override to handle the list request with url param validation.
v1_data_files_list 3 params → 200
POST
/v1/data_files/
Override create to upload in case of successful scan.
v1_data_files_create 12 params → 201
GET
/v1/data_files/years
Handle get action for get list of years there are datafiles.
v1_data_files_years_list 1 param → 200
GET
/v1/data_files/years/{stt}
Handle get action for get list of years there are datafiles.
v1_data_files_years_read 2 params → 200
GET
/v1/data_files/{id}/
Data file views.
v1_data_files_read 1 param → 200
GET
/v1/data_files/{id}/download/
Retrieve a file from s3 then stream it to the client.
v1_data_files_download 1 param → 200
GET
/v1/data_files/{id}/download_error_report/
Generate and return the parsing error report xlsx.
v1_data_files_download_error_report 1 param → 200
GET
/v1/feature-flags/
Get the feature flag list from the cache if available, else fetch the queryset.
v1_feature-flags_list → 200
GET
/v1/feature-flags/{feature_name}/
Get the feature flag from cache if available, fallback to db.
v1_feature-flags_read 1 param → 200
GET
/v1/feedback/
Feedback viewset.
v1_feedback_list 1 param → 200
POST
/v1/feedback/
Create feedback with user.
v1_feedback_create 1 param → 201
GET
/v1/feedback/{id}/
Feedback viewset.
v1_feedback_read 1 param → 200
PUT
/v1/feedback/{id}/
Update feedback.
v1_feedback_update 2 params → 200
PATCH
/v1/feedback/{id}/
Feedback viewset.
v1_feedback_partial_update 2 params → 200
DELETE
/v1/feedback/{id}/
Override the destroy method to disallow it.
v1_feedback_delete 1 param → 204
GET
/v1/login/
Handle decoding auth token and authenticate user.
v1_login_list → 200
POST
/v1/login/
Define methods for handling login request from login.gov.
v1_login_create 1 param → 201
GET
/v1/logout
Destroy user session.
v1_logout_list → 200
POST
/v1/logs/
Pass request bodies to the system logger.
v1_logs_create → 201
GET
/v1/oidc/ams
Handle decoding auth token and authenticate user.
v1_oidc_ams_list → 200
POST
/v1/oidc/ams
Define methods for handling login request from HHS AMS.
v1_oidc_ams_create 1 param → 201
GET
/v1/reports/
Report file views.
v1_reports_list 1 param → 200
POST
/v1/reports/
Report file views.
v1_reports_create 1 param → 201
GET
/v1/reports/report-sources/
Report source views for batch uploading report files.
v1_reports_report-sources_list 1 param → 200
POST
/v1/reports/report-sources/
Create a new report source and trigger async processing.
v1_reports_report-sources_create 1 param → 201
GET
/v1/reports/report-sources/{id}/
Report source views for batch uploading report files.
v1_reports_report-sources_read 1 param → 200
GET
/v1/reports/{id}/
Report file views.
v1_reports_read 1 param → 200
GET
/v1/reports/{id}/download/
Retrieve a file from s3 then stream it to the client.
v1_reports_download 1 param → 200
GET
/v1/roles/
GET for groups (roles).
v1_roles_list → 200
POST
/v1/security/event-token
Process incoming Security Event Token from Login.gov.
v1_security_event-token_create → 201
GET
/v1/security/get-token
Generate new token for the API user.
v1_security_get-token_list → 200
GET
/v1/stts/
Simple view to get all STTs.
v1_stts_list → 200
GET
/v1/stts/alpha
Simple view to get all STTs alphabetized.
v1_stts_alpha_list → 200
GET
/v1/stts/by_region
Simple view to get all regions and STTs, without pagination.
v1_stts_by_region_list → 200
GET
/v1/users/
User accounts viewset.
v1_users_list 1 param → 200
GET
/v1/users/profile/
Get the current user's profile.
v1_users_profile 1 param → 200
GET
/v1/users/request_access/
Update request.user with provided data, set accountapprovalstatus to 'Access Request'.
v1_users_request_access_read 1 param → 200
PATCH
/v1/users/request_access/
Update request.user with provided data, set accountapprovalstatus to 'Access Request'.
v1_users_request_access_partial_update 1 param → 200
PATCH
/v1/users/update_profile/
Update the current user's profile through change requests.
v1_users_update_profile 1 param → 200
GET
/v1/users/{id}/
Return a specific user.
v1_users_read 1 param → 200
PUT
/v1/users/{id}/
User accounts viewset.
v1_users_update 2 params → 200
PATCH
/v1/users/{id}/
User accounts viewset.
v1_users_partial_update 2 params → 200

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are UserProfileChangeRequest (25 properties), DataFile (21 properties), UserProfile (19 properties), User (16 properties). Each schema is shown below with its type and property counts.

AuthToken
object
3 properties 2 required
Permission
object
4 properties 2 required
UserChangeRequest
object
6 properties 2 required
User
object
16 properties
Group
object
3 properties 2 required
ReportFile
object
11 properties 2 required
DataFile
object
21 properties 8 required
ChangeRequestAuditLog
object
6 properties
FeedbackAttachments
object
2 properties 2 required
STT
object
9 properties 1 required
Feedback
object
9 properties 1 required
Region
object
2 properties 2 required
ReportSource
object
12 properties
UserProfileChangeRequest
object
25 properties 2 required
UserProfile
object
19 properties 2 required
DataFileSummary
object
3 properties 1 required
FeatureFlag
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

the-administration-for-children-and-families-v1-api-openapi.yml Raw ↑

Other APIs The Administration for Children and Families publishes across the network.

TANF Data Portal
AE Profile APIs.io
ACF Human Services Interoperability Initiative
AE Profile APIs.io
National Data Archive on Child Abuse and Neglect
AE Profile APIs.io
ACF Data and Research Portal
AE Profile APIs.io
The Administration for Children and Families plg_auth_check API
AE Profile APIs.io
#v1
← Back to T APIs
API Details
ID
the-administration-for-children-and-families:the-administration-for-children-and-families-v1-api
Base URL
https://tanfdata.acf.hhs.gov/
Docs
https://tanfdata.acf.hhs.gov/
Provider
The Administration for Children and Families
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network