# Alter API

**Canonical:** https://apis.io/apis/alterauth-com/alterauth-com-api/  
**Provider:** Alter — https://apis.io/providers/alterauth-com/  
**Documentation:** https://docs.alterauth.com/reference/managed-ramp

Alter API is one of 2 APIs that [Alter](https://apis.io/providers/alterauth-com/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. The published artifact set on APIs.io includes an OpenAPI specification.

Alter API as documented publicly: 157 operations. Contract generated from the documentation by API Evangelist (2026-11-01); not the provider's own document.

## Operations (60 of 157)

| Method | Path | Summary |
|---|---|---|
| POST | `/account` | quickbooks.account.create_an_account and quickbooks.account.full_update_an_account share POST /account |
| DELETE | `/ai_agents/{agentId}` | delete_ai_agents_id delete |
| DELETE | `/collaboration_whitelist_entries/{collaborationWhitelistEntryId}` | delete_collaboration_whitelist_entries_id delete |
| DELETE | `/collaboration_whitelist_exempt_targets/{collaborationWhitelistExemptTargetId}` | delete_collaboration_whitelist_exempt_targets_id admin, delete |
| DELETE | `/collaborations/{collaborationId}` | delete_collaborations_id delete |
| POST | `/comments` | post_comments send |
| DELETE | `/comments/{commentId}` | delete_comments_id delete |
| GET | `/comments/{commentId}` | Policy-cataloged operations |
| PUT | `/comments/{commentId}` | put_comments_id send |
| DELETE | `/device_pinners/{devicePinnerId}` | delete_device_pinners_id delete |
| DELETE | `/file_requests/{fileRequestId}` | delete_file_requests_id delete |
| GET | `/file_requests/{fileRequestId}` | Policy-cataloged operations |
| POST | `/file_requests/{fileRequestId}/copy` | Policy-cataloged operations |
| GET | `/file_version_legal_holds/{fileVersionLegalHoldId}` | Alter policy rules can target these attested operations and families for operation-level and parameter-aware controls. |
| GET | `/file_version_retentions/{fileVersionRetentionId}` | Alter policy rules can target these attested operations and families for operation-level and parameter-aware controls. |
| DELETE | `/files/upload_sessions/{uploadSessionId}` | delete_files_upload_sessions_id |
| DELETE | `/files/{fileId}` | delete_files_id |
| GET | `/files/{fileId}` | Alter policy rules can target these attested operations and families for operation-level and parameter-aware controls. |
| POST | `/files/{fileId}` | Policy-cataloged operations |
| GET | `/files/{fileId}/app_item_associations` | Alter policy rules can target these attested operations and families for operation-level and parameter-aware controls. |
| POST | `/files/{fileId}/content` | Policy-cataloged operations |
| POST | `/files/{fileId}/copy` | Policy-cataloged operations |
| DELETE | `/files/{fileId}/metadata/{scope}/{templateKey}` | delete_files_id_metadata_id_id |
| POST | `/files/{fileId}/metadata/{scope}/{templateKey}` | post_files_id_metadata_id_id |
| PUT | `/files/{fileId}/metadata/{scope}/{templateKey}` | Policy-cataloged operations |
| DELETE | `/files/{fileId}/trash` | delete_files_id_trash |
| POST | `/files/{fileId}/upload_sessions` | Policy-cataloged operations |
| POST | `/files/{fileId}/versions/current` | Policy-cataloged operations |
| DELETE | `/files/{fileId}/versions/{fileVersionId}` | delete_files_id_versions_id |
| DELETE | `/files/{fileId}/watermark` | delete_files_id_watermark |
| DELETE | `/folder_locks/{folderLockId}` | delete_folder_locks_id |
| POST | `/folders/{folderId}/metadata/{scope}/{templateKey}` | post_folders_id_metadata_id_id |
| GET | `/functions/{function}/executions/{execution}/logs` | Execution‑log scope compatibility: For GET /functions/{function}/executions/{execution}/logs, Alter accepts either function‑executions.read or the historical... |
| POST | `/invites` | post_invites admin, send |
| POST | `/metadata_taxonomies/{namespace}/{taxonomyKey}/levels` | post_metadata_taxonomies_id_id_levels |
| POST | `/metadata_taxonomies/{namespace}/{taxonomyKey}/nodes` | Policy-cataloged operations |
| POST | `/oauth2/token` | Alter policy rules can target these attested operations and families for operation-level and parameter-aware controls. |
| DELETE | `/rest/adjustments/{id}` | Policy-cataloged operations |
| GET | `/rest/adjustments/{id}` | adjustments_getcontractadjustment |
| GET | `/rest/ats/application-forms/{applicationFormId}` | ats_retrieveatsapplicationform_v2026_01_01 |
| GET | `/rest/ats/application-sources` | atsapplicationsources_retrievealistofatsapplicationsources |
| GET | `/rest/ats/applications` | atsapplications_retrievealistofatsapplications_v2026_01_01 |
| GET | `/rest/ats/applications/{applicationId}` | Policy-cataloged operations |
| GET | `/rest/ats/applications/{applicationId}/feedbacks` | Policy-cataloged operations |
| GET | `/rest/ats/attachments/{attachableTypeSlug}/{attachableId}/{attachmentTypeSlug}` | Policy-cataloged operations |
| GET | `/rest/ats/candidates` | Policy-cataloged operations |
| GET | `/rest/ats/candidates/{candidateId}` | Policy-cataloged operations |
| GET | `/rest/ats/departments` | Policy-cataloged operations |
| GET | `/rest/ats/email-templates` | Policy-cataloged operations |
| GET | `/rest/ats/employment-types` | Policy-cataloged operations |
| GET | `/rest/ats/feedbacks` | Policy-cataloged operations |
| GET | `/rest/ats/hires` | Policy-cataloged operations |
| GET | `/rest/ats/hiring-members` | Policy-cataloged operations |
| GET | `/rest/ats/interviews` | Policy-cataloged operations |
| GET | `/rest/ats/interviews/{interviewId}/transcript` | Read interview transcript |
| GET | `/rest/ats/job-boards` | Retrieve list of ATS job boards |
| GET | `/rest/ats/job-boards/{jobBoardId}/job-postings` | Retrieve list of job postings for a job board |
| GET | `/rest/ats/job-postings` | Retrieve list of ATS job postings |
| GET | `/rest/ats/job-postings/{jobPostingId}` | Retrieve a specific ATS job posting |
| GET | `/rest/ats/jobs` | Retrieve list of ATS jobs |

…and 97 more operations. They are listed in full on the page.

## Machine-readable artifacts (1)

- **OpenAPI** — https://artifacts.apis.io/alterauth-com/openapi/_ae-authored/alterauth-com-openapi-generated.yml

## Other Alter APIs (1)

- [Alter API](https://apis.io/apis/alterauth-com/alter-api/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/alterauth-com/alterauth-com-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/alterauth-com/.