AtlasWork, planned itself.

    The AI-native, all-in-one work platform. Tasks, projects, CRM, contracts, and analytics in one calm workspace.

    System status
    • SSO
    • SCIM
    • Two-factor sign-in
    • Audit log

    Product

    • Overview
    • PDF tools
    • Diagram tools
    • People & HR
    • Integrations
    • Marketplace
    • Pricing

    Resources

    • Guides
    • Glossary
    • Compare
    • Docs
    • API reference
    • Support
    • Changelog
    • Status

    Company

    • About
    • Careers
    • Press
    • Contact

    Legal & trust

    • Trust center
    • Security
    • Privacy
    • Terms
    • DPA
    • GDPR
    • SLA
    • Refunds
    • Google API data
    Atlas, a product by wrxstack.com·© 2026 wrxstack·All rights reserved
    PrivacyTermsSecurityStatus

    You are in control of your cookies

    Atlas uses strictly necessary cookies to keep you signed in. With your consent, we add anonymized product analytics, conversion attribution, and remembered preferences. Change your mind any time at /privacy/cookies.

    Off until you agree · Change it any time

    • Necessaryalways on
    • Analyticsopt-in
    • Marketingopt-in
    • Preferencesopt-in
    Skip to documentation
    Docs
    Back to Atlas

    Start here

    • Overview

    Developer

    • REST API guide
    • Authentication
    • API reference
    • MCP (AI agents)
    • MCP tools reference
    • SDKs
    • Quick actions
    • Changelog

    Webhooks

    • Overview
    • Quickstart
    • Events
    • Payloads and headers
    • Security and signing
    • Delivery and retries
    • Managing via API

    Connect

    • Connectors
    • Integrations

    Product

    • Collaboration and chat
    • Signing in and security
    • Client portal

    Reference

    • Glossary
    • Keyboard shortcuts
    • Module reference

    Tools reference

    Client delivery

    Every Client delivery tool, with the scope it needs, its arguments and the API operation it calls.

    All areasTasksProjectsPortfoliosBoardsGoalsHabitsCommentsTime trackingWorkloadCRMGrowth suiteContractseSignPDF StudioFormsCalendarBookingMeetingsChatHuddlesWikiDocumentationDiagramsWhiteboardsHRPayrollClient deliveryClient onboardingService operationsStatus pageAutomationsAgentsAIReportsInsightsConnectorsNotificationsSearchWorkspace administrationAccessGovernancePrivacyBillingWebhooksAccess tokensMy accountFocusChangelogBlogTrashThemesEmail templatesMetadataCustom fieldsWalkthroughsVoiceActivityServer

    463 tools

    List delivery engagements acceptance blockers

    Read only

    atlas_delivery_engagements_acceptance_blockers_list

    List everything stopping a deliverable from being accepted: unmet criteria, open review notes, missing reviews and missing sign-off. An empty list means it can be accepted.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/deliverables/{childId}/acceptance-blockers
    Example prompt
    What is stopping the operating model deliverable from being accepted?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    deliverableIdstringYesThe deliverable id.

    Update delivery engagements acceptance check terms

    Changes data

    atlas_delivery_engagements_acceptance_check_terms_update

    Change the terms a check runs under: the export control restrictions and the enhanced due diligence facts. Send only the fields that change. Returns the check.

    Scope
    delivery:write
    Calls
    PATCH /v1/engagements/{engagementId}/acceptance/checks/{childId}/compliance
    Example prompt
    Record that only US persons may work on the export control check.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    checkIdstringYesThe acceptance check id.
    sourceOfFundsstring | nullNoWhere the client money comes from, or null to clear it.
    sourceOfWealthstring | nullNoHow the client accumulated its wealth, or null to clear it.
    deemedExportRiskbooleanNoWhether the work carries a deemed export risk.
    nationalityRestrictionsOnTeamarray of stringNoNationalities that may not work on the engagement.
    usPersonOnlyFlagbooleanNoWhether only US persons may work on the engagement.
    eccnOrUsmlCategorystring | nullNoThe export control classification or USML category, or null to clear it.
    licenceNumberstring | nullNoThe export licence number, or null to clear it.
    licenceExpirystring (date-time) | nullNoWhen the export licence expires, as an ISO 8601 UTC date-time, or null to clear it.

    Create delivery engagements acceptance checks

    Changes data

    atlas_delivery_engagements_acceptance_checks_create

    Add an acceptance check to an engagement, for example a sanctions screen on a named party. Returns the check.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/acceptance/checks
    Example prompt
    Add a sanctions check on Northwind Holdings.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    kind"CONFLICT_OF_INTEREST" | "INDEPENDENCE" | "SANCTIONS" | "PEP" | "KYC_AML" | "BENEFICIAL_OWNERSHIP" | "CREDIT" | "ADVERSE_MEDIA" | "EXPORT_CONTROL" | "ANTI_BRIBERY" | "SECURITY_REVIEW" | "INSURANCE_CERTIFICATE" | "DPIA" | "SUBPROCESSOR_DISCLOSURE" | "BACKGROUND_CHECK" | "TAX_FORM"YesWhat kind of check this is.
    subjectLabelstringYesWho or what the check is about.
    subjectContactIdstringNoThe CRM contact id the check is about.
    requiredbooleanNoWhether the check must clear before the engagement can start.
    providerstringNoThe provider that ran the check.
    externalRefstringNoThe reference the external provider uses.
    sourceOfFundsstringNoWhere the client money comes from.
    sourceOfWealthstringNoHow the client accumulated its wealth.
    deemedExportRiskbooleanNoWhether the work carries a deemed export risk.
    nationalityRestrictionsOnTeamarray of stringNoNationalities that may not work on the engagement.
    usPersonOnlyFlagbooleanNoWhether only US persons may work on the engagement.
    eccnOrUsmlCategorystringNoThe export control classification or USML category.
    licenceNumberstringNoThe export licence number.
    licenceExpirystring (date-time)NoWhen the export licence expires, as an ISO 8601 UTC date-time.

    List delivery engagements acceptance checks

    Read only

    atlas_delivery_engagements_acceptance_checks_list

    List the acceptance checks of one engagement, such as conflicts, sanctions and anti-money-laundering checks, with their state and expiry.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/acceptance/checks
    Example prompt
    Which acceptance checks are still outstanding on Northwind?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Create delivery engagements acceptance

    Changes data

    atlas_delivery_engagements_acceptance_create

    Open the client acceptance record for an engagement, with the facts the risk assessment rests on. The checks those facts require are created with it. Returns the record.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/acceptance
    Example prompt
    Open client acceptance for Northwind as a high-risk, cross-border engagement.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    accountIdstringYesThe CRM account id of the client.
    dealIdstringNoThe CRM deal id the engagement came from.
    isContinuancebooleanNoWhether this continues an earlier engagement with the client.
    priorEngagementIdstringNoThe earlier engagement this one continues.
    riskTier"LOW" | "MEDIUM" | "HIGH" | "VERY_HIGH"NoThe risk tier.
    riskRationalestringNoWhy the risk tier was chosen.
    serviceDescriptionstringNoWhat the firm will do for the client.
    jurisdictionstringNoThe governing jurisdiction.
    regulatedSectorstringNoThe regulated sector, if any.
    publicInterestEntitybooleanNoWhether the client is a public interest entity.
    processesPersonalDatabooleanNoWhether the work processes personal data.
    usesSubcontractorsbooleanNoWhether the work uses subcontractors.
    crossBorderbooleanNoWhether the work crosses a national border.

    Get delivery engagements acceptance

    Read only

    atlas_delivery_engagements_acceptance_get

    Read the client acceptance record of one engagement: its risk tier, the facts it was assessed on, its checks and the decision.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/acceptance
    Example prompt
    Show me the client acceptance record for Northwind.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Review delivery engagements acceptance

    Changes data

    atlas_delivery_engagements_acceptance_review

    Move the client acceptance record into review, so the decision can be taken. Returns the record.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/acceptance/review
    Example prompt
    Move the Northwind acceptance into review.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Update delivery engagements acceptance

    Changes data

    atlas_delivery_engagements_acceptance_update

    Change the facts of the client acceptance record. The checks are brought in line with the new facts. Send only the fields that change. Returns the record.

    Scope
    delivery:write
    Calls
    PATCH /v1/engagements/{engagementId}/acceptance
    Example prompt
    Record that the Northwind work will use subcontractors.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    dealIdstringNoThe CRM deal id the engagement came from.
    isContinuancebooleanNoWhether this continues an earlier engagement with the client.
    priorEngagementIdstringNoThe earlier engagement this one continues.
    riskTier"LOW" | "MEDIUM" | "HIGH" | "VERY_HIGH"NoThe risk tier.
    riskRationalestringNoWhy the risk tier was chosen.
    serviceDescriptionstringNoWhat the firm will do for the client.
    jurisdictionstringNoThe governing jurisdiction.
    regulatedSectorstringNoThe regulated sector, if any.
    publicInterestEntitybooleanNoWhether the client is a public interest entity.
    processesPersonalDatabooleanNoWhether the work processes personal data.
    usesSubcontractorsbooleanNoWhether the work uses subcontractors.
    crossBorderbooleanNoWhether the work crosses a national border.

    List delivery engagements access grants

    Read only

    atlas_delivery_engagements_access_grants_list

    List the access grants on an engagement: who holds access, the reason recorded, when it expires and which workstreams it is limited to. Requires administrator access to the engagement.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/access-grants
    Example prompt
    Who has access to the Northwind engagement?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Revoke delivery engagements access grants

    Destructive

    atlas_delivery_engagements_access_grants_revoke

    Revoke one access grant on an engagement, so its holder no longer reaches the engagement through it. This removes access and cannot grant any. Returns the revoked grant.

    Scope
    delivery:write
    Calls
    DELETE /v1/engagements/{engagementId}/access-grants/{childId}
    Example prompt
    Revoke the access grant for the contractor who left the Northwind engagement.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    grantIdstringYesThe access grant id.

    List delivery engagements access provisions

    Read only

    atlas_delivery_engagements_access_provisions_list

    List the client system access the team holds on an engagement: each system, access level, team member, when it was granted, whether credentials were issued, when it expires, and whether it has been revoked.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/access-provisions
    Example prompt
    Which client systems does the team still have access to on Northwind?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Record delivery engagements access provisions

    Changes data

    atlas_delivery_engagements_access_provisions_record

    Record that the client gave a team member access to one of its systems, with the access level, dates and whether credentials were issued. This is the register of access already given; it does not grant access to anything. Returns the record.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/access-provisions
    Example prompt
    Log that the client gave Omar read-only access to their SAP system today.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    systemNamestringYesThe client system the access is to.
    accessLevelstringNoThe level of access, such as read only.
    teamMemberIdstringNoThe engagement team member id of the person who holds it.
    grantedAtstring (date-time)NoWhen the access was granted, as an ISO 8601 date-time in UTC.
    credentialsIssuedbooleanNoWhether the client issued credentials for it.
    expiresAtstring (date-time)NoWhen the access expires, as an ISO 8601 date-time in UTC.
    notesstringNoNotes on the access.

    Revoke delivery engagements access provisions

    Destructive

    atlas_delivery_engagements_access_provisions_revoke

    Record that access to a client system has been removed, with the evidence of its removal, such as the client ticket reference. Returns the updated record.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/access-provisions/{childId}/revoke
    Example prompt
    Record that Omar's SAP access was removed under ticket INC-4412.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    provisionIdstringYesThe access provision id.
    revocationEvidencestringYesThe evidence the access was removed, such as a ticket reference.

    Generate delivery engagements AI drafts deliverable qa

    Changes data

    atlas_delivery_engagements_ai_drafts_deliverable_qa_generate

    Ask for an AI quality pre-check of a deliverable. The result is a proposed draft of findings that a person reviews. Returns the draft.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/ai-drafts/deliverable-qa
    Example prompt
    Pre-check the final report before it goes to review.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    deliverableIdstringYesThe id of the deliverable to pre-check.

    Get delivery engagements AI drafts

    Read only

    atlas_delivery_engagements_ai_drafts_get

    Read one AI draft with its proposed content and the keys that can be accepted.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/ai-drafts/{draftId}
    Example prompt
    Show me the draft minutes for the steering meeting.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    draftIdstringYesThe AI draft id.

    Generate delivery engagements AI drafts health explanation

    Changes data

    atlas_delivery_engagements_ai_drafts_health_explanation_generate

    Ask for an AI explanation of the current health ratings of an engagement, drawn from its registers. Returns the proposed draft.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/ai-drafts/health-explanation
    Example prompt
    Explain why this engagement is amber.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    List delivery engagements AI drafts

    Read only

    atlas_delivery_engagements_ai_drafts_list

    List the AI drafts proposed on an engagement, optionally by kind and status. A draft changes nothing until a person accepts it.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/ai-drafts
    Example prompt
    Which AI drafts are waiting for review?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    kind"STATUS_REPORT" | "MINUTES" | "RAID_EXTRACTION" | "DELIVERABLE_QA" | "HEALTH_EXPLANATION"NoOnly drafts of this kind.
    status"PROPOSED" | "ACCEPTED" | "REJECTED" | "SUPERSEDED"NoOnly drafts in this status.
    limitintegerNoThe largest number of rows to return.

    Generate delivery engagements AI drafts minutes

    Changes data

    atlas_delivery_engagements_ai_drafts_minutes_generate

    Ask for AI draft minutes of a governed meeting. The minutes are a proposal until a person accepts them. Returns the draft.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/ai-drafts/minutes
    Example prompt
    Draft the minutes for yesterday's steering meeting.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    meetingIdstringYesThe id of the meeting to draft minutes for.

    Generate delivery engagements AI drafts RAID items

    Changes data

    atlas_delivery_engagements_ai_drafts_raid_items_generate

    Ask the AI to propose RAID items from up to ten meetings and twenty threads. The proposals are a draft until a person accepts them. Returns the draft.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/ai-drafts/raid
    Example prompt
    Suggest risks from the last three steering meetings.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    meetingIdsarray of stringNoThe ids of up to ten meetings to read.
    threadIdsarray of stringNoThe ids of up to twenty threads to read.

    Reject delivery engagements AI drafts

    Changes data

    atlas_delivery_engagements_ai_drafts_reject

    Reject an AI draft, with an optional note, so it is not applied. Returns the updated draft.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/ai-drafts/{draftId}/reject
    Example prompt
    Reject the draft status report, the tone is wrong.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    draftIdstringYesThe AI draft id.
    notestringNoWhy the draft is rejected.

    Generate delivery engagements AI drafts status report

    Changes data

    atlas_delivery_engagements_ai_drafts_status_report_generate

    Ask for an AI draft of the narrative of a status report. The narrative is a proposal until a person accepts it. Returns the draft.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/ai-drafts/status-report
    Example prompt
    Draft the narrative for this week's status report.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    statusReportIdstringYesThe id of the status report to draft the narrative for.

    Mark delivery engagements analyses blocked

    Changes data

    atlas_delivery_engagements_analyses_blocked_mark

    Mark an analysis as blocked, with the reason. Returns the updated analysis.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/structuring/analyses/{childId}/block
    Example prompt
    The churn analysis is blocked waiting on the CRM extract.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    analysisIdstringYesThe analysis id.
    reasonstringYesWhat the analysis is waiting on.

    Complete delivery engagements analyses

    Changes data

    atlas_delivery_engagements_analyses_complete

    Complete an analysis with its finding summary and so-what, and optionally its confidence and actual effort. Only a completed analysis counts as evidence behind a storyline page. Returns the updated analysis.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/structuring/analyses/{childId}/complete
    Example prompt
    Complete the churn analysis: churn is concentrated in year-one SME customers.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    analysisIdstringYesThe analysis id.
    findingSummarystringYesWhat the analysis found.
    soWhatstringYesWhat the finding means for the client.
    confidenceintegerNoConfidence as a percentage, from 0 to 100.
    effortActualMinintegerNoThe actual effort in minutes.

    Create delivery engagements analyses

    Changes data

    atlas_delivery_engagements_analyses_create

    Plan an analysis on an engagement: what it is, which hypothesis it tests, its type, owner, reviewer and dates. Returns the created analysis.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/structuring/analyses
    Example prompt
    Plan a customer churn analysis to test hypothesis 2, owned by Sam, due in two weeks.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    titlestringYesA short title, in one line.
    descriptionstringNoThe detail behind it.
    hypothesisIdstringNoThe id of the hypothesis it tests.
    workstreamIdstringNoThe id of the engagement workstream it belongs to.
    analysisType"QUANTITATIVE" | "INTERVIEW" | "SURVEY" | "BENCHMARK" | "DESK_RESEARCH" | "MODEL" | "SITE_VISIT" | "WORKSHOP"NoThe kind of analysis.
    endProductstringNoWhat the analysis produces, such as a chart or a model.
    ownerUserIdstringNoThe Atlas user id of the person who owns it.
    reviewerUserIdstringNoThe Atlas user id of the reviewer.
    plannedStartsOnstring (date-time)NoWhen the work is planned to start, as an ISO 8601 date-time in UTC.
    dueOnstring (date-time)NoWhen it is due, as an ISO 8601 date-time in UTC.
    effortEstimateMinintegerNoThe estimated effort in minutes.
    planItemIdstringNoThe id of the plan item it relates to.
    deliverableIdstringNoThe id of the engagement deliverable.

    List delivery engagements analyses

    Read only

    atlas_delivery_engagements_analyses_list

    List the analyses on an engagement, optionally by status, hypothesis or workstream. Each carries its type, owner, dates and findings.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/structuring/analyses
    Example prompt
    Which analyses are blocked?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    status"PLANNED" | "IN_PROGRESS" | "BLOCKED" | "COMPLETE" | "CANCELLED" | "SUPERSEDED"NoFilter to one status.
    hypothesisIdstringNoOnly analyses that test this hypothesis.
    workstreamIdstringNoOnly analyses in this workstream.
    limitintegerNoThe largest number of rows to return.

    Start delivery engagements analyses

    Changes data

    atlas_delivery_engagements_analyses_start

    Start a planned analysis, moving it from planned to in progress. Returns the updated analysis.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/structuring/analyses/{childId}/start
    Example prompt
    Start the pricing benchmark analysis.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    analysisIdstringYesThe analysis id.

    Update delivery engagements analyses

    Changes data

    atlas_delivery_engagements_analyses_update

    Change the fields of an analysis, including its findings, so-what and confidence while it is in progress. Only the fields sent change. Returns the updated analysis.

    Scope
    delivery:write
    Calls
    PATCH /v1/engagements/{engagementId}/structuring/analyses/{childId}
    Example prompt
    Update the churn analysis finding to say retention is worst in the SME segment.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    analysisIdstringYesThe analysis id.
    titlestringNoA short title, in one line.
    descriptionstringNoThe detail behind it.
    hypothesisIdstringNoThe id of the hypothesis it tests.
    workstreamIdstringNoThe id of the engagement workstream it belongs to.
    analysisType"QUANTITATIVE" | "INTERVIEW" | "SURVEY" | "BENCHMARK" | "DESK_RESEARCH" | "MODEL" | "SITE_VISIT" | "WORKSHOP"NoThe kind of analysis.
    endProductstringNoWhat the analysis produces, such as a chart or a model.
    ownerUserIdstringNoThe Atlas user id of the person who owns it.
    reviewerUserIdstringNoThe Atlas user id of the reviewer.
    plannedStartsOnstring (date-time)NoWhen the work is planned to start, as an ISO 8601 date-time in UTC.
    dueOnstring (date-time)NoWhen it is due, as an ISO 8601 date-time in UTC.
    effortEstimateMinintegerNoThe estimated effort in minutes.
    planItemIdstringNoThe id of the plan item it relates to.
    deliverableIdstringNoThe id of the engagement deliverable.
    findingSummarystringNoWhat the analysis found.
    soWhatstringNoWhat the finding means for the client.
    confidenceintegerNoConfidence as a percentage, from 0 to 100.
    effortActualMinintegerNoThe actual effort in minutes.

    Create delivery engagements analytical assumptions

    Changes data

    atlas_delivery_engagements_analytical_assumptions_create

    Record an analytical assumption: the statement, the variable, its basis, its base, low and high values, and where it is used. Returns the recorded assumption.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/analytical-assumptions
    Example prompt
    Record the assumption that churn stays at 8 percent, based on client data.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    statementstringYesThe statement, in full.
    variableNamestringYesThe name of the variable in the model.
    basis"CLIENT_PROVIDED" | "BENCHMARK" | "EXPERT_JUDGMENT" | "REGRESSION" | "PLACEHOLDER"YesWhat the value rests on.
    analysisIdstringNoThe id of the structuring analysis it relates to.
    baseValuestringNoThe base case value, as a decimal string.
    unitstringNoThe unit of the value, such as percent or GBP.
    lowCasestringNoThe low case value, as a decimal string.
    highCasestringNoThe high case value, as a decimal string.
    distributionstringNoThe probability distribution assumed, such as triangular.
    sourceIdstringNoThe id of the structuring source it came from.
    ownerUserIdstringNoThe Atlas user id of the person who owns it.
    materialityOfErrorstringNoHow much an error in the value would matter, as a decimal string.
    isKeyDriverbooleanNoWhether the assumption is a key driver of the result.
    usedInModelsarray of stringNoThe names or ids of the models that use it.
    usedInExhibitsarray of stringNoThe names of the exhibits that use it.
    invalidationTriggersstringNoThe events that would make the assumption invalid.
    restatementRequiredbooleanNoWhether figures that rely on it must be restated.
    disclosedInDeliverableIdstringNoThe id of the deliverable in which the assumption is disclosed.
    clientAgreedbooleanNoWhether the client has agreed the assumption.
    expiresAtstring (date-time)NoWhen it expires, as an ISO 8601 date-time in UTC.

    List delivery engagements analytical assumptions

    Read only

    atlas_delivery_engagements_analytical_assumptions_list

    List the analytical assumptions of an engagement: each variable with its base, low and high case, basis, validation status and which models use it.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/analytical-assumptions
    Example prompt
    What assumptions drive the business case?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Update delivery engagements analytical assumptions

    Changes data

    atlas_delivery_engagements_analytical_assumptions_update

    Revise the basis, disclosure deliverable or expiry of an analytical assumption. Returns the updated assumption.

    Scope
    delivery:write
    Calls
    PATCH /v1/engagements/{engagementId}/analytical-assumptions/{assumptionId}
    Example prompt
    Change the basis of the churn assumption to benchmark.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    assumptionIdstringYesThe assumption id.
    basis"CLIENT_PROVIDED" | "BENCHMARK" | "EXPERT_JUDGMENT" | "REGRESSION" | "PLACEHOLDER"NoWhat the value rests on.
    disclosedInDeliverableIdstring | nullNoThe id of the deliverable that discloses the assumption, or null to clear it.
    expiresAtstring (date-time) | nullNoWhen the assumption expires, as an ISO 8601 date-time in UTC, or null to clear it.

    Void delivery engagements analytical assumptions

    Destructive

    atlas_delivery_engagements_analytical_assumptions_void

    Record that an analytical assumption no longer holds, with a note, and whether figures that rely on it must be restated. Returns the updated assumption.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/analytical-assumptions/{assumptionId}/invalidate
    Example prompt
    The churn assumption is wrong, invalidate it and flag a restatement.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    assumptionIdstringYesThe assumption id.
    restatementRequiredbooleanNoWhether figures that rely on it must be restated.
    notestringNoWhy the assumption no longer holds.

    List delivery engagements approvals

    Read only

    atlas_delivery_engagements_approvals_list

    Read the approval history of one record with its current position: whether the version as it stands is approved. A record can have approvals against earlier versions and still not be approved as it stands.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/approvals/{subjectType}/{subjectId}
    Example prompt
    Is the current version of the operating model approved?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    subjectType"DELIVERABLE" | "MINUTES" | "CHANGE_REQUEST" | "STATUS_REPORT" | "PHASE_GATE" | "CLOSURE" | "INFO_REQUEST"YesWhat kind of record the approvals are about.
    subjectIdstringYesThe id of the record the approvals are about.

    Archive delivery engagements

    Changes data

    atlas_delivery_engagements_archive

    Archive an engagement. It leaves the default lists but keeps every record, and it can be restored. Returns the archived engagement.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{id}/archive
    Example prompt
    Archive the finished Contoso pilot engagement.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Record delivery engagements assets consent

    Changes data

    atlas_delivery_engagements_assets_consent_record

    Record that the client has consented to reuse of an asset, with the evidence. Returns the updated asset.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/assets/{assetId}/consent
    Example prompt
    Record the client consent to reuse the case study, evidence attached.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    assetIdstringYesThe asset id.
    consentEvidenceIdstringNoThe id of the attachment that evidences the client consent.

    Create delivery engagements assets

    Changes data

    atlas_delivery_engagements_assets_create

    Harvest a reusable asset from an engagement: its kind, title, classification, tags, attachment, and whether client consent is required before reuse. Returns the asset.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/assets
    Example prompt
    Harvest the pricing model template as a reusable asset.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    kind"TEMPLATE" | "MODEL" | "CODE" | "DATASET" | "METHODOLOGY" | "CREDENTIAL" | "CASE_STUDY" | "BENCHMARK" | "TRAINING"YesWhat kind of asset it is.
    titlestringYesA short title, in one line.
    descriptionstringNoThe detail behind it.
    classification"PUBLIC" | "INTERNAL" | "CONFIDENTIAL" | "RESTRICTED"NoThe classification of the asset.
    tagsarray of stringNoFree-text tags.
    clientConsentRequiredbooleanNoWhether the client must consent before the asset is reused.
    attachmentIdstringNoThe id of an attachment already uploaded to Atlas.

    List delivery engagements assets

    Read only

    atlas_delivery_engagements_assets_list

    List the reusable assets harvested from an engagement with their kind, classification, consent and sanitisation state.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/assets
    Example prompt
    What reusable assets came out of this engagement?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Record delivery engagements assets reuse

    Changes data

    atlas_delivery_engagements_assets_reuse_record

    Record that an asset has been reused. The API refuses reuse of an asset that still needs consent or sanitisation. Returns the updated asset.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/assets/{assetId}/reuse
    Example prompt
    Record that we reused the pricing template.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    assetIdstringYesThe asset id.

    Delete delivery engagements attachments

    Destructive

    atlas_delivery_engagements_attachments_delete

    Delete a file attached to an engagement, removing it from the engagement file list. Use this only when the person asks to delete it.

    Scope
    attachments:delete
    Calls
    DELETE /engagements/{engagementId}/attachments/{attachmentId}
    Example prompt
    Remove the outdated org chart from the Northwind files.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    attachmentIdstringYesThe attachment id.

    Download delivery engagements attachments

    Read only

    atlas_delivery_engagements_attachments_download

    Get a short-lived download URL for a file attached to an engagement. Returns the URL and when it expires.

    Scope
    attachments:read
    Calls
    GET /engagements/{engagementId}/attachments/{attachmentId}/download
    Example prompt
    Give me a download link for the Northwind statement of work.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    attachmentIdstringYesThe attachment id.

    Finalize delivery engagements attachments

    Changes data

    atlas_delivery_engagements_attachments_finalize

    Finish an upload started with atlas_delivery_engagements_attachments_upload, once the bytes have been sent. Returns the attachment.

    Scope
    attachments:write
    Calls
    POST /engagements/{engagementId}/attachments/{attachmentId}/finalize
    Example prompt
    Finish attaching the statement of work I just uploaded.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    attachmentIdstringYesThe attachment id.
    actualSizeBytesintegerYesThe size of the file as uploaded, in bytes.
    actualContentTypestringYesThe content type of the file as uploaded.

    List delivery engagements attachments

    Read only

    atlas_delivery_engagements_attachments_list

    List the files attached to one engagement, with their names, sizes and who can see them.

    Scope
    attachments:read
    Calls
    GET /engagements/{engagementId}/attachments
    Example prompt
    What files are attached to the Northwind engagement?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Revoke delivery engagements attachments share

    Destructive

    atlas_delivery_engagements_attachments_share_revoke

    Take an engagement file back from the client portal, so only the firm sees it. The change is audited and recorded on the timeline.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/attachments/{childId}/unshare
    Example prompt
    Take the draft org chart back from the Northwind client portal.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    attachmentIdstringYesThe attachment id.

    Upload delivery engagements attachments

    Changes data

    atlas_delivery_engagements_attachments_upload

    Start uploading a file to an engagement. Returns an upload URL and an attachment id: send the file bytes to the URL, then call atlas_delivery_engagements_attachments_finalize with the id.

    Scope
    attachments:write
    Calls
    POST /engagements/{engagementId}/attachments/ticket
    Example prompt
    Attach this statement of work to the Northwind engagement.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    namestringYesThe file name, with its extension.
    contentTypestringYesThe content type of the file, for example application/pdf.
    sizeBytesintegerYesThe size of the file in bytes.

    Get delivery engagements authority chain

    Read only

    atlas_delivery_engagements_authority_chain_get

    Work out who must approve a decision of a given kind and value on an engagement, from its delegation of authority, including the bands that apply to the whole workspace. Returns the approval chain and how many bands were considered. Use this to answer "who has to sign off a write-off of this size".

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/authority/derive-chain
    Example prompt
    Who has to approve a 12,500 write-off on Northwind?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    subjectKind"DISCOUNT" | "WRITE_OFF" | "CHANGE_REQUEST" | "SIGN_OFF" | "EXPENSE" | "CONTRACT"YesThe kind of decision.
    valuenumberYesThe value of the decision, compared against the threshold of each band.

    List delivery engagements authority

    Read only

    atlas_delivery_engagements_authority_list

    List the delegation of authority that applies to an engagement: for each kind of decision and value band, the approver role or person and whether a second approver is required.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/authority
    Example prompt
    What is the delegation of authority on this engagement?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Close delivery engagements barriers crossings

    Changes data

    atlas_delivery_engagements_barriers_crossings_close

    Close an open wall crossing, so the person it admitted is outside the information barrier again. This restores the wall; it cannot admit anybody. Returns the crossing id and whether it was closed.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/barriers/crossings/{crossingId}/close
    Example prompt
    Close the wall crossing for Sam on Project Falcon now that the call is over.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    crossingIdstringYesThe wall crossing id.

    List delivery engagements barriers crossings

    Read only

    atlas_delivery_engagements_barriers_crossings_list

    List the open wall crossings on an engagement: who was brought over an information barrier, for what purpose, on whose approval and until when. Closed crossings are not included, because they need no action.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/barriers/crossings
    Example prompt
    Who has been brought over the wall on Project Falcon, and until when?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Add delivery engagements barriers insiders

    Changes data

    atlas_delivery_engagements_barriers_insiders_add

    Add a person to the insider list of an engagement, recording that they hold inside information, their function and the reason, and when they obtained it. This records a fact; it does not admit the person through any barrier. Returns the entry.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/barriers/insiders
    Example prompt
    Add Priya to the Project Falcon insider list; she joined the valuation call today.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    partyKeystringYesThe party key of the person, which is their Atlas user id for a member of the firm.
    fullNamestringYesThe full name of the person.
    functionAndReasonstringYesTheir function and the reason they hold inside information.
    obtainedAccessAtstringNoWhen they obtained the information, as an ISO 8601 date-time.

    List delivery engagements barriers insiders

    Read only

    atlas_delivery_engagements_barriers_insiders_list

    List the insider list of an engagement: every person recorded as holding inside information, why, when they obtained it, and whether they have been notified of their obligations and acknowledged them.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/barriers/insiders
    Example prompt
    Show me the insider list for Project Falcon.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Record delivery engagements barriers insiders obligation

    Changes data

    atlas_delivery_engagements_barriers_insiders_obligation_record

    Record one step of an insider list obligation: that the person was notified of their duties, or that they acknowledged them. The two are separate steps under market abuse rules, so each is recorded on its own, and only once it has happened. Returns the entry.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/barriers/insiders/{entryId}/obligation
    Example prompt
    Record that Priya was notified of her insider obligations.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    entryIdstringYesThe insider list entry id.
    step"notified" | "acknowledged"YesWhich step happened: notified, or acknowledged by the person.

    List delivery engagements barriers

    Read only

    atlas_delivery_engagements_barriers_list

    List the information barriers on an engagement: each barrier type, reason, the parties on each side, the excluded parties, the enforcement points, any code name and the dates it is in force. Use this to answer "is there an ethical wall on this engagement".

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/barriers
    Example prompt
    Is there an ethical wall on the Northwind engagement?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Get delivery engagements barriers name

    Read only

    atlas_delivery_engagements_barriers_name_get

    Ask which name the caller may use for an engagement under a code-named barrier. Pass the real name; the answer is the real name for a person inside the wall and the code name for anybody else, with a flag saying which it is. Use this before writing about a deal that may be code named.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/barriers/name
    Example prompt
    Which name should I use for the Acme deal in my notes?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    realNamestringYesThe real name of the client or deal, which is returned only to a person inside the wall.

    Get delivery engagements baseline variance

    Read only

    atlas_delivery_engagements_baseline_variance_get

    Compare the plan with one named baseline rather than the current one. Use this to answer "what did the last replan cost".

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/baselines/{childId}/variance
    Example prompt
    What did the last replan cost against the original baseline?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    baselineIdstringYesThe baseline id.

    Capture delivery engagements baselines

    Changes data

    atlas_delivery_engagements_baselines_capture

    Capture the plan as it stands as a named baseline: the original, a rebaseline after a change, or a what-if. Returns the baseline.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/baselines
    Example prompt
    Capture a what-if baseline before we replan.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    namestringYesThe baseline name.
    kind"ORIGINAL" | "REBASELINE" | "WHAT_IF"NoWhat kind of baseline this is.
    descriptionstringNoWhy the baseline was captured.
    changeRequestIdstringNoThe change request the baseline was captured for.

    Delete delivery engagements baselines

    Destructive

    atlas_delivery_engagements_baselines_delete

    Delete a baseline that is no longer needed, such as a what-if. The current baseline cannot be deleted.

    Scope
    delivery:write
    Calls
    DELETE /v1/engagements/{engagementId}/baselines/{childId}
    Example prompt
    Delete the what-if baseline we no longer need.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    baselineIdstringYesThe baseline id.

    Get delivery engagements baselines

    Read only

    atlas_delivery_engagements_baselines_get

    Read one baseline with the dates of every plan item it captured.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/baselines/{childId}
    Example prompt
    Show me the original Northwind baseline.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    baselineIdstringYesThe baseline id.

    List delivery engagements baselines

    Read only

    atlas_delivery_engagements_baselines_list

    List the baselines of one engagement, marking which is current.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/baselines
    Example prompt
    Which baselines does Northwind have?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Create delivery engagements benchmarks

    Changes data

    atlas_delivery_engagements_benchmarks_create

    Record a benchmark: the metric and its definition, the peer set, the data source and vintage, the quartiles, the client value and gaps, and licence and anonymisation constraints. Returns the recorded benchmark.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/benchmarks
    Example prompt
    Record the cost-to-serve benchmark against the 12 peer banks.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    metricNamestringYesThe metric name.
    metricDefinitionstringYesThe exact definition of the metric.
    normalisationBasisstringNoHow the figures are normalised, such as per employee.
    peerSetDefinitionstringNoHow the peer set was chosen.
    peerSetMembersarray of stringNoThe names of the peers.
    dataSourceIdstringNoThe id of the structuring source that supplied the data.
    dataVintagestringNoThe period the benchmark data describes, such as FY2024.
    sampleSizeintegerNoHow many peers are in the sample.
    quartilesobjectNoThe peer set quartile values, keyed by quartile.
    clientValuestringNoThe client value for the metric, as a decimal string.
    clientPercentileintegerNoThe client percentile in the peer set, from 0 to 100.
    gapToMedianstringNoThe gap from the client value to the peer median, as a decimal string.
    gapToTopQuartilestringNoThe gap from the client value to the top quartile, as a decimal string.
    gapValueInCurrencystringNoThe value of closing the gap, as a decimal string in the engagement currency.
    adjustmentsAppliedarray of stringNoThe adjustments applied to make the figures comparable.
    comparabilityCaveatsstringNoWhy the peers may not be fully comparable.
    licencePermitsClientUsebooleanNoWhether the data licence permits showing the benchmark to the client.
    anonymisationRequiredbooleanNoWhether the peers must be anonymised before the client sees the benchmark.

    Delete delivery engagements benchmarks

    Destructive

    atlas_delivery_engagements_benchmarks_delete

    Delete a benchmark recorded in error. Returns the result of the deletion.

    Scope
    delivery:write
    Calls
    DELETE /v1/engagements/{engagementId}/benchmarks/{benchmarkId}
    Example prompt
    Delete the duplicate benchmark.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    benchmarkIdstringYesThe benchmark id.

    Link delivery engagements benchmarks

    Changes data

    atlas_delivery_engagements_benchmarks_link

    Attach a benchmark to a deliverable, so it is shown and checked as part of it. Returns the updated benchmark.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/benchmarks/{benchmarkId}/attach
    Example prompt
    Attach the cost-to-serve benchmark to the final report.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    benchmarkIdstringYesThe benchmark id.
    deliverableIdstringYesThe id of the deliverable to attach the benchmark to.

    List delivery engagements benchmarks

    Read only

    atlas_delivery_engagements_benchmarks_list

    List the benchmarks on an engagement, optionally only those without a competition law review or those attached to one deliverable.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/benchmarks
    Example prompt
    Which benchmarks still need a competition law review?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    unreviewedOnlybooleanNoWhen true, return only benchmarks with no competition law review recorded.
    deliverableIdstringNoOnly benchmarks attached to this deliverable.
    limitintegerNoThe largest number of rows to return.

    Unlink delivery engagements benchmarks

    Changes data

    atlas_delivery_engagements_benchmarks_unlink

    Detach a benchmark from the deliverable it is attached to. Returns the updated benchmark.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/benchmarks/{benchmarkId}/detach
    Example prompt
    Take the cost-to-serve benchmark off the final report.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    benchmarkIdstringYesThe benchmark id.

    Update delivery engagements benchmarks

    Changes data

    atlas_delivery_engagements_benchmarks_update

    Change the fields of a benchmark. Only the fields sent change; send null to clear a field that allows it. Returns the updated benchmark.

    Scope
    delivery:write
    Calls
    PATCH /v1/engagements/{engagementId}/benchmarks/{benchmarkId}
    Example prompt
    Update the client value on the cost-to-serve benchmark to 41.2.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    benchmarkIdstringYesThe benchmark id.
    metricNamestringNoThe metric name.
    metricDefinitionstringNoThe exact definition of the metric.
    normalisationBasisstring | nullNoHow the figures are normalised, such as per employee, or null to clear it.
    peerSetDefinitionstring | nullNoHow the peer set was chosen, or null to clear it.
    peerSetMembersarray of stringNoThe names of the peers.
    dataSourceIdstringNoThe id of the structuring source that supplied the data.
    dataVintagestring | nullNoThe period the benchmark data describes, such as FY2024, or null to clear it.
    sampleSizeintegerNoHow many peers are in the sample.
    quartilesobjectNoThe peer set quartile values, keyed by quartile.
    clientValuestring | nullNoThe client value for the metric, as a decimal string, or null to clear it.
    clientPercentileintegerNoThe client percentile in the peer set, from 0 to 100.
    gapToMedianstringNoThe gap from the client value to the peer median, as a decimal string.
    gapToTopQuartilestringNoThe gap from the client value to the top quartile, as a decimal string.
    gapValueInCurrencystringNoThe value of closing the gap, as a decimal string in the engagement currency.
    adjustmentsAppliedarray of stringNoThe adjustments applied to make the figures comparable.
    comparabilityCaveatsstring | nullNoWhy the peers may not be fully comparable, or null to clear it.
    licencePermitsClientUsebooleanNoWhether the data licence permits showing the benchmark to the client.
    anonymisationRequiredbooleanNoWhether the peers must be anonymised before the client sees the benchmark.

    Add delivery engagements beneficial owners

    Changes data

    atlas_delivery_engagements_beneficial_owners_add

    Add a beneficial owner of the client to an acceptance check, with how they control it, their ownership share, their details, their screening results and the registry the information came from. Returns the owner.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/beneficial-owners
    Example prompt
    Add Jane Doe as a 30 percent shareholder beneficial owner on the acceptance check.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    checkIdstringYesThe acceptance check id the owner belongs to.
    namestringYesThe full name of the owner.
    controlType"SHARES" | "VOTING" | "OTHER" | "SENIOR_MANAGING_OFFICIAL"YesHow the owner controls the client.
    dateOfBirthstringNoThe date of birth.
    nationalitystringNoThe nationality.
    residencestringNoThe country of residence.
    ownershipPercentstringNoThe ownership share as a percentage, such as 25.5.
    pepStatus"NOT_SCREENED" | "CLEAR" | "PEP" | "BLOCKED"NoThe politically exposed person screening result.
    sanctionsStatus"NOT_SCREENED" | "CLEAR" | "PEP" | "BLOCKED"NoThe sanctions screening result.
    registrySourcestringNoThe registry the ownership information came from.

    Get delivery engagements beneficial owners assessment

    Read only

    atlas_delivery_engagements_beneficial_owners_assessment_get

    Apply the fifty percent rule to the beneficial owners of an acceptance check: add up the holdings of every owner recorded as blocked and say whether the client is itself blocked. The result is also written onto the latest screening run.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/beneficial-owners/{checkId}/ownership-assessment
    Example prompt
    Is Acme Holdings blocked under the fifty percent rule?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    checkIdstringYesThe acceptance check id.

    Record delivery engagements beneficial owners discrepancy

    Changes data

    atlas_delivery_engagements_beneficial_owners_discrepancy_record

    Record that a discrepancy between the beneficial owner the firm found and the public register has been reported to the register. This records the report; it does not send one. Returns the owner.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/beneficial-owners/{uboId}/discrepancy
    Example prompt
    Record that we reported the Companies House discrepancy for Jane Doe.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    uboIdstringYesThe beneficial owner id.

    List delivery engagements beneficial owners

    Read only

    atlas_delivery_engagements_beneficial_owners_list

    List the beneficial owners recorded on an engagement: each owner, how they control the client, their ownership share, their screening status and whether a register discrepancy was reported.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/beneficial-owners
    Example prompt
    Who are the beneficial owners recorded for Acme Holdings?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Create delivery engagements benefits

    Changes data

    atlas_delivery_engagements_benefits_create

    Add a benefit to the register: its type, name, measure, unit, baseline and target values, attribution percentage and currency. Returns the benefit.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/benefits
    Example prompt
    Track a cost reduction benefit of 2 million pounds against a 10 million baseline.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    type"COST_REDUCTION" | "REVENUE_INCREASE" | "RISK_REDUCTION" | "COMPLIANCE" | "CAPABILITY" | "CUSTOMER_EXPERIENCE" | "SPEED" | "QUALITY"YesWhat kind of benefit it is.
    namestringYesThe benefit name.
    measurestringNoHow the benefit is measured.
    unitstringNoThe unit of the value, such as percent or GBP.
    baselineValuenumberNoThe value before the engagement.
    targetValuenumberNoThe value the engagement aims for.
    attributionPercentnumberNoThe share of the benefit attributed to the engagement, as a percentage.
    doubleCountGuardNotestringNoHow double counting with other benefits is avoided.
    currencystringNoAn ISO 4217 currency code, such as GBP or USD.

    List delivery engagements benefits

    Read only

    atlas_delivery_engagements_benefits_list

    List the benefits register of an engagement: each benefit with its type, measure, baseline, target, attribution and readings.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/benefits
    Example prompt
    What benefits are we tracking for the client?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Record delivery engagements benefits readings

    Changes data

    atlas_delivery_engagements_benefits_readings_record

    Record a reading of a benefit at a date, with its source. Returns the reading.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/benefits/{benefitId}/readings
    Example prompt
    Record a reading of 1.2 million on the cost benefit as of 30 June.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    benefitIdstringYesThe benefit id.
    asOfstringYesThe date the reading was taken, as an ISO 8601 date.
    valuenumberYesThe measured value.
    sourcestringNoWhere the reading came from.
    notestringNoA note recorded with the change.

    Create delivery engagements billing milestones

    Changes data

    atlas_delivery_engagements_billing_milestones_create

    Add a billing milestone to an engagement, with what makes it billable and the amount. Returns the milestone.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/commercials/billing-milestones
    Example prompt
    Add a 50,000 billing milestone triggered by acceptance of the operating model.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    namestringYesThe milestone name.
    sequenceintegerNoThe order of the milestone, from 1.
    trigger"DATE" | "DELIVERABLE_ACCEPTED" | "MILESTONE_REACHED" | "PERCENT_COMPLETE" | "ON_SIGNATURE" | "MONTHLY_IN_ARREARS" | "MANUAL"NoWhat makes the milestone billable.
    triggerDatestring (date-time)NoThe date the milestone becomes billable, for a date trigger.
    triggerDeliverableIdstringNoThe deliverable whose acceptance makes the milestone billable.
    triggerMilestoneIdstringNoThe plan milestone whose completion makes the milestone billable.
    triggerPercentintegerNoThe percent complete that makes the milestone billable.
    amountstringYesThe amount, as a decimal string with at most two places.
    currencystringNoThe ISO 4217 currency code, for example USD.
    poNumberstringNoThe client purchase order number.
    notesstringNoNotes.

    Mark delivery engagements billing milestones disputed

    Changes data

    atlas_delivery_engagements_billing_milestones_disputed_mark

    Mark a billing milestone as disputed by the client, with the reason. Returns the milestone.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/commercials/billing-milestones/{childId}/dispute
    Example prompt
    The client disputes the design milestone invoice.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    billingMilestoneIdstringYesThe billing milestone id.
    reasonstringYesWhat the client disputes.

    Mark delivery engagements billing milestones held

    Changes data

    atlas_delivery_engagements_billing_milestones_held_mark

    Put a billing milestone on hold, with the reason. Returns the milestone.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/commercials/billing-milestones/{childId}/hold
    Example prompt
    Put the build milestone on hold until the purchase order arrives.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    billingMilestoneIdstringYesThe billing milestone id.
    reasonstringYesWhy the milestone is on hold.

    Mark delivery engagements billing milestones invoiced

    Changes data

    atlas_delivery_engagements_billing_milestones_invoiced_mark

    Mark a billing milestone as invoiced, with the invoice reference. Returns the milestone.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/commercials/billing-milestones/{childId}/mark-invoiced
    Example prompt
    Mark the design milestone as invoiced on INV-2291.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    billingMilestoneIdstringYesThe billing milestone id.
    invoiceRefstringYesThe invoice reference.
    invoicedAtstring (date-time)NoWhen the invoice was raised, as an ISO 8601 UTC date-time. Defaults to now.

    List delivery engagements billing milestones

    Read only

    atlas_delivery_engagements_billing_milestones_list

    List the billing milestones of one engagement with their trigger, amount and state: planned, earned, invoiced, paid, disputed or on hold.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/commercials/billing-milestones
    Example prompt
    Which Northwind billing milestones are not yet invoiced?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Mark delivery engagements billing milestones paid

    Changes data

    atlas_delivery_engagements_billing_milestones_paid_mark

    Mark an invoiced billing milestone as paid. Returns the milestone.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/commercials/billing-milestones/{childId}/mark-paid
    Example prompt
    Mark the design milestone as paid.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    billingMilestoneIdstringYesThe billing milestone id.

    List delivery engagements budgets

    Read only

    atlas_delivery_engagements_budgets_list

    Read the budgets of one engagement, at engagement, phase, workstream or deliverable level, each with its planned effort, planned cost, planned revenue, contingency and management reserve. Use this to answer "what did we plan to spend".

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/commercials/budgets
    Example prompt
    What budget did we set for each workstream on Northwind?

    Arguments

    FieldTypeRequiredDescription
    idstringYesThe engagement id.

    List delivery engagements change approvals

    Read only

    atlas_delivery_engagements_change_approvals_list

    List the approval steps of a change request with each approver and their decision.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/change-requests/{childId}/approvals
    Example prompt
    Who still has to decide on the second workshop change?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    changeRequestIdstringYesThe change request id.

    Add delivery engagements change approvers

    Changes data

    atlas_delivery_engagements_change_approvers_add

    Add an approver to a change request at a given step, as a member, a client contact or an external party. Returns the approval step.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/change-requests/{childId}/approvals
    Example prompt
    Add the Northwind sponsor as an approver on the workshop change.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    changeRequestIdstringYesThe change request id.
    stepintegerYesThe approval step, from 1. Approvers at the same step decide in parallel.
    approverPartyType"USER" | "CLIENT_CONTACT" | "EXTERNAL"NoWho the approver is: a member, a client contact, or an external party.
    approverUserIdstringNoThe member id of the approver.
    approverContactIdstringNoThe CRM contact id of the approver, for a client approver.
    approverLabelstringNoThe approver name, for an approver who is neither a member nor a contact.
    rolestringNoThe approver role, for example Sponsor.
    requiredbooleanNoWhether the approver must decide before the change can be approved.
    hasVetobooleanNoWhether the approver can veto the change alone.

    Complete delivery engagements change requests

    Changes data

    atlas_delivery_engagements_change_requests_complete

    Mark an approved change request as implemented. Returns the change request.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/change-requests/{childId}/implement
    Example prompt
    Mark the approved workshop change as implemented.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    changeRequestIdstringYesThe change request id.

    Create delivery engagements change requests

    Changes data

    atlas_delivery_engagements_change_requests_create

    Raise a change request against an engagement. It is created as a draft with no impact assessed and no approvers, which is deliberate: assessing the impact and deciding the change belong to people. Use this to capture that a change has been requested, not to approve one.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/change-requests
    Example prompt
    Raise a change request for the extra migration run.

    Arguments

    FieldTypeRequiredDescription
    idstringYesThe engagement id.
    titlestringYesWhat is changing, in one line.
    descriptionstringNoThe detail behind it.
    type"SCOPE" | "SCHEDULE" | "COST" | "RESOURCE" | "QUALITY" | "CONTRACT" | "ASSUMPTION" | "TECHNICAL"NoWhat kind of change this is.
    urgency"LOW" | "MEDIUM" | "HIGH" | "CRITICAL"NoHow urgent it is.

    Mark delivery engagements change requests deferred

    Changes data

    atlas_delivery_engagements_change_requests_deferred_mark

    Defer a change request to be considered later, with the reason. Returns the change request.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/change-requests/{childId}/defer
    Example prompt
    Defer the reporting change request until phase two.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    changeRequestIdstringYesThe change request id.
    reasonstringYesWhy the change was deferred.

    Delete delivery engagements change requests

    Destructive

    atlas_delivery_engagements_change_requests_delete

    Delete a change request that is still open. A decided change is part of the record and is refused; withdraw an open change instead when its history should stay.

    Scope
    delivery:write
    Calls
    DELETE /v1/engagements/{engagementId}/change-requests/{childId}
    Example prompt
    Delete the change request I raised twice.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    changeRequestIdstringYesThe change request id.

    Get delivery engagements change requests drift

    Read only

    atlas_delivery_engagements_change_requests_drift_get

    Cumulative drift from approved changes, measured against the ORIGINAL baseline rather than the current one. This is the number that catches ten changes each comfortably under the approval threshold whose sum has moved the engagement thirty percent from what was signed.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/change-requests/drift
    Example prompt
    How far has Northwind drifted from its baseline?

    Arguments

    FieldTypeRequiredDescription
    idstringYesThe engagement id.

    Get delivery engagements change requests

    Read only

    atlas_delivery_engagements_change_requests_get

    Read one change request with its impact assessment, approval steps and history.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/change-requests/{childId}
    Example prompt
    Show me the change request for the second workshop.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    changeRequestIdstringYesThe change request id.

    List delivery engagements change requests

    Read only

    atlas_delivery_engagements_change_requests_list

    Read the change register for one engagement: every change request with its type, status, schedule impact in days and cost impact.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/change-requests
    Example prompt
    What changes have been raised on Northwind?

    Arguments

    FieldTypeRequiredDescription
    idstringYesThe engagement id.

    Review delivery engagements change requests

    Changes data

    atlas_delivery_engagements_change_requests_review

    Start the review of a submitted change request, so its approvers can decide. Returns the change request in its new state.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/change-requests/{childId}/review
    Example prompt
    Start the review of the second workshop change request.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    changeRequestIdstringYesThe change request id.

    Revoke delivery engagements change requests share

    Destructive

    atlas_delivery_engagements_change_requests_share_revoke

    Take a change request back from the client portal, with the reason. The change is audited and recorded on the timeline.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/change-requests/{childId}/unshare
    Example prompt
    Take the pricing change request back from the client portal.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    changeRequestIdstringYesThe change request id.
    reasonstringYesWhy the change request is taken back from the client.

    Submit delivery engagements change requests

    Changes data

    atlas_delivery_engagements_change_requests_submit

    Submit a change request for review. Returns the change request in its new state.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/change-requests/{childId}/submit
    Example prompt
    Submit the second workshop change request for review.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    changeRequestIdstringYesThe change request id.

    Get delivery engagements change requests summary

    Read only

    atlas_delivery_engagements_change_requests_summary_get

    Summarise the change register of one engagement: the count in each status, and the value sitting in the approval chain that has not landed yet.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/change-requests/summary
    Example prompt
    How much change value is waiting in the approval chain on Northwind?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Update delivery engagements change requests

    Changes data

    atlas_delivery_engagements_change_requests_update

    Change the title, description, type, urgency or flags of a change request. Send only the fields that change. Returns the change request.

    Scope
    delivery:write
    Calls
    PATCH /v1/engagements/{engagementId}/change-requests/{childId}
    Example prompt
    Make the second workshop change request high urgency.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    changeRequestIdstringYesThe change request id.
    titlestringNoWhat is changing, in one line.
    descriptionstringNoThe detail behind it.
    type"SCOPE" | "SCHEDULE" | "COST" | "RESOURCE" | "QUALITY" | "CONTRACT" | "ASSUMPTION" | "TECHNICAL"NoWhat kind of change this is.
    urgency"LOW" | "MEDIUM" | "HIGH" | "CRITICAL"NoHow urgent it is.
    workstreamIdstring | nullNoThe workstream id.
    requiresClientApprovalbooleanNoWhether the client must approve the change.
    requiresContractAmendmentbooleanNoWhether the change needs a contract amendment.
    rebaselineRequiredbooleanNoWhether the plan must be rebaselined if the change is approved.

    Withdraw delivery engagements change requests

    Changes data

    atlas_delivery_engagements_change_requests_withdraw

    Withdraw a change request, with the reason. The record stays. Returns the change request.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/change-requests/{childId}/withdraw
    Example prompt
    Withdraw the second workshop change request; the client dropped it.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    changeRequestIdstringYesThe change request id.
    reasonstringYesWhy the change was withdrawn.

    Generate delivery engagements closure items

    Changes data

    atlas_delivery_engagements_closure_items_generate

    Create the standard closure checklist for an engagement. An engagement that already has one is left unchanged. Returns the checklist.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/closure/items/seed
    Example prompt
    Create the closure checklist for Northwind.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    List delivery engagements closure items

    Read only

    atlas_delivery_engagements_closure_items_list

    List the closure checklist of one engagement with the state of each item.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/closure/items
    Example prompt
    What is left on the Northwind closure checklist?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Reopen delivery engagements closure items

    Changes data

    atlas_delivery_engagements_closure_items_reopen

    Reopen a closure checklist item that was done or waived. Returns the item.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/closure/items/{itemId}/reopen
    Example prompt
    Reopen the archive closure item; the files were not all moved.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    closureItemIdstringYesThe closure checklist item id.

    Get delivery engagements closure readiness

    Read only

    atlas_delivery_engagements_closure_readiness_get

    Answer "can this engagement close". Returns whether it is ready, every blocker and warning at once, and the closure checklist it was judged against.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/closure/readiness
    Example prompt
    Can the Northwind engagement close yet?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Create delivery engagements comments

    Changes data

    atlas_delivery_engagements_comments_create

    Post a comment on an engagement, or a reply to another comment. Returns the new comment.

    Scope
    comments:write
    Calls
    POST /engagements/{engagementId}/comments
    Example prompt
    Comment on the Northwind engagement that the kickoff moved to Tuesday.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    bodystringYesThe comment text.
    parentCommentIdstringNoThe comment this one replies to.

    List delivery engagements comments

    Read only

    atlas_delivery_engagements_comments_list

    List the comments on one engagement, oldest first, one page at a time. Use this to read the discussion on an engagement.

    Scope
    comments:read
    Calls
    GET /engagements/{engagementId}/comments
    Example prompt
    Show me the discussion on the Northwind engagement.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    cursorstringNoThe cursor from the previous page, to read the next one.
    limitintegerNoPage size (1..100).

    Create delivery engagements commercial terms

    Changes data

    atlas_delivery_engagements_commercial_terms_create

    Record a commercial term from the contract. Send the term type and the fields that apply to it: caps, intellectual property, warranty, service levels, key personnel, acceptance, audit, step-in, benchmarking and so on. Returns the term.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/commercial-terms
    Example prompt
    Record a liability cap of 1 times fees paid over a rolling 12 months.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    termTypestringYesThe kind of term, such as LIABILITY_CAP, IP, WARRANTY, SLA, KEY_PERSONNEL or ACCEPTANCE.
    instrumentIdstringNoThe id of the legal instrument the term comes from.
    clauseRefstringNoThe contract clause reference.
    clauseTextstringNoThe contract clause text.
    capType"FEES_PAID" | "MULTIPLE_OF_FEES" | "FIXED_SUM" | "UNLIMITED"NoHow the liability cap is set.
    capAmountstringNoThe cap amount as a decimal string, for a fixed sum or a multiple of fees.
    capPeriod"ROLLING_12M" | "AGGREGATE"NoThe period the cap applies over.
    superCapsarray of objectNoHigher caps for specific heads of loss, one object per cap.
    uncappedHeadsarray of stringNoHeads of liability that are not capped.
    excludedLossesarray of stringNoHeads of loss excluded from liability.
    backgroundIpOwnerstringNoWho owns background intellectual property.
    foregroundIpOwnerstringNoWho owns foreground intellectual property created on the engagement.
    licenceGrantobjectNoThe licence granted over the intellectual property, as structured terms.
    residualKnowledgeClausebooleanNoWhether the contract has a residual knowledge clause.
    aiOutputOwnershipstringNoWho owns output produced with AI, as the contract states.
    aiTrainingProhibitionbooleanNoWhether the contract prohibits training AI on client data.
    warrantyPeriodDaysintegerNoHow many days the warranty lasts.
    remedy"RE_PERFORM" | "REFUND" | "REPAIR"NoThe remedy for a warranty breach.
    metricstringNoThe service level metric.
    targetstringNoThe service level target.
    windowstringNoThe measurement window of the service level.
    exclusionsstringNoWhat the term excludes.
    serviceCreditPercentstringNoThe service credit as a percentage string.
    creditCapstringNoThe cap on service credits.
    earnBackstringNoHow service credits can be earned back.
    chronicFailureTriggerstringNoThe pattern of service level failures that counts as chronic.
    namedIndividualsarray of stringNoThe names of the key personnel.
    minTenureMonthsintegerNoThe minimum months named key personnel must stay.
    replacementApprovalRequiredbooleanNoWhether the client must approve a replacement for key personnel.
    replacementNoticeDaysintegerNoHow many days of notice are needed to replace key personnel.
    substitutionPenaltystringNoThe penalty for substituting key personnel.
    reviewPeriodDaysintegerNoHow many days the client has to review a deliverable.
    deemedAcceptancebooleanNoWhether a deliverable is deemed accepted when the review period passes without a decision.
    deemedAcceptanceDaysintegerNoHow many days pass before deemed acceptance.
    rejectionGroundsstringNoThe grounds on which a deliverable may be rejected.
    resubmissionCyclesAllowedintegerNoHow many times a rejected deliverable may be resubmitted.
    auditorstringNoWho may carry out an audit under the term.
    noticeDaysintegerNoHow many days of notice the term requires.
    costBearerstringNoWhich party bears the cost.
    regulatorStepInRightbooleanNoWhether a regulator has a step-in right.
    durationMonthsintegerNoHow many months the term lasts.
    ratestringNoThe rate the term sets, as written in the contract.
    exitPlanRequiredBystring (date-time)NoWhen the exit plan is required by, as an ISO 8601 date-time in UTC.
    rightToBenchmarkbooleanNoWhether the client may benchmark prices.
    benchmarkerstringNoWho carries out a price benchmark.
    adjustmentMechanismstringNoHow prices are adjusted after a benchmark.
    frequencystringNoHow often the term applies, such as annually.
    scopestringNoWhat the term covers.
    directionstringNoWhich party the term binds.
    durationstringNoHow long the term lasts.
    consentRequiredbooleanNoWhether the other party must consent.
    eventsarray of stringNoThe events the term applies to.
    noticestringNoThe notice the term requires.
    dueAtstring (date-time)NoWhen the term takes effect or falls due, as an ISO 8601 date-time in UTC.

    Delete delivery engagements commercial terms

    Destructive

    atlas_delivery_engagements_commercial_terms_delete

    Delete a commercial term recorded in error. Returns the result of the deletion.

    Scope
    delivery:write
    Calls
    DELETE /v1/engagements/{engagementId}/commercial-terms/{termId}
    Example prompt
    Delete the duplicate warranty term.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    termIdstringYesThe commercial term id.

    List delivery engagements commercial terms

    Read only

    atlas_delivery_engagements_commercial_terms_list

    List the commercial terms recorded from the contract of an engagement: liability caps, intellectual property, warranties, service levels, key personnel, acceptance, audit, benchmarking and others.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/commercial-terms
    Example prompt
    What is the liability cap on this engagement?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Get delivery engagements commercials burn

    Read only

    atlas_delivery_engagements_commercials_burn_get

    Read the burn of one engagement: the budget at completion, actual cost to date, burn rate per day, the days of runway left at that rate, and percent complete. Use this to answer "when does the budget run out".

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/commercials/burn
    Example prompt
    When does the Northwind budget run out at the current burn?

    Arguments

    FieldTypeRequiredDescription
    idstringYesThe engagement id.
    asOfstring (date-time)NoThe date the figures are computed at, as an ISO 8601 UTC date-time ending in Z. Defaults to now.
    eacFormula"AC_PLUS_REMAINING" | "BAC_OVER_CPI" | "AC_PLUS_REMAINING_OVER_CPI_SPI"NoThe estimate-at-completion formula: AC_PLUS_REMAINING, BAC_OVER_CPI or AC_PLUS_REMAINING_OVER_CPI_SPI.

    Get delivery engagements commercials effort

    Read only

    atlas_delivery_engagements_commercials_effort_get

    Read the effort of one engagement: actual, billable and non-billable effort in minutes, utilisation and leverage.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/commercials/effort
    Example prompt
    How much of the effort on Northwind has been billable?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    asOfstring (date-time)NoThe date the figures are computed at, as an ISO 8601 UTC date-time. Defaults to now.
    eacFormula"AC_PLUS_REMAINING" | "BAC_OVER_CPI" | "AC_PLUS_REMAINING_OVER_CPI_SPI"NoThe estimate-at-completion formula to use.

    Get delivery engagements commercials

    Read only

    atlas_delivery_engagements_commercials_get

    Read the live financial picture of one engagement, computed at the moment of asking: budget at completion, actual cost, earned and invoiced revenue, unbilled work in progress, margin, realisation, burn rate, runway and the estimate at completion. Use this to answer "how is this engagement doing financially". Pass `asOf` to see the picture at an earlier date.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/commercials
    Example prompt
    How is the Northwind engagement doing financially?

    Arguments

    FieldTypeRequiredDescription
    idstringYesThe engagement id.
    asOfstring (date-time)NoThe date the figures are computed at, as an ISO 8601 UTC date-time ending in Z. Defaults to now.
    eacFormula"AC_PLUS_REMAINING" | "BAC_OVER_CPI" | "AC_PLUS_REMAINING_OVER_CPI_SPI"NoThe estimate-at-completion formula: AC_PLUS_REMAINING, BAC_OVER_CPI or AC_PLUS_REMAINING_OVER_CPI_SPI.

    Get delivery engagements commercials profitability

    Read only

    atlas_delivery_engagements_commercials_profitability_get

    Read the profitability of one engagement: planned, earned and invoiced revenue, unbilled work in progress, over-billing, actual cost, margin percent, realisation percent, effective rate, and the estimate and variance at completion. Use this to answer "are we making money on this engagement".

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/commercials/profitability
    Example prompt
    What margin are we making on Northwind?

    Arguments

    FieldTypeRequiredDescription
    idstringYesThe engagement id.
    asOfstring (date-time)NoThe date the figures are computed at, as an ISO 8601 UTC date-time ending in Z. Defaults to now.
    eacFormula"AC_PLUS_REMAINING" | "BAC_OVER_CPI" | "AC_PLUS_REMAINING_OVER_CPI_SPI"NoThe estimate-at-completion formula: AC_PLUS_REMAINING, BAC_OVER_CPI or AC_PLUS_REMAINING_OVER_CPI_SPI.

    Acknowledge delivery engagements complaints

    Changes data

    atlas_delivery_engagements_complaints_acknowledge

    Acknowledge a complaint, which stops its acknowledgement clock. Returns the updated complaint.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/complaints/{complaintId}/acknowledge
    Example prompt
    Acknowledge the CFO complaint.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    complaintIdstringYesThe complaint id.

    Close delivery engagements complaints

    Changes data

    atlas_delivery_engagements_complaints_close

    Close a resolved complaint with its root cause and preventive action, optionally linked to the RAID item that records the underlying problem. Returns the updated complaint.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/complaints/{complaintId}/close
    Example prompt
    Close the late reports complaint: root cause was a missing review step.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    complaintIdstringYesThe complaint id.
    rootCausestringYesThe root cause of the complaint.
    preventiveActionstringYesWhat has been changed so it does not happen again.
    linkedRaidItemIdstringNoThe id of a RAID item that records the underlying problem.

    Create delivery engagements complaints

    Changes data

    atlas_delivery_engagements_complaints_create

    Record a client complaint: its severity, category, description, who raised it, the owner and the target resolution date. Returns the complaint.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/complaints
    Example prompt
    Log a high severity complaint from the CFO about late reports.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    severity"LOW" | "MEDIUM" | "HIGH" | "CRITICAL"YesHow severe it is.
    category"DELIVERY" | "QUALITY" | "COMMERCIAL" | "CONDUCT" | "COMMUNICATION" | "TIMELINESS" | "PEOPLE" | "DATA" | "OTHER"YesWhat the complaint is about.
    descriptionstringYesWhat the client complained about.
    raisedByContactIdstringNoThe CRM contact id of the client contact who raised it.
    ownerUserIdstringNoThe Atlas user id of the person who owns it.
    targetResolutionAtstringNoWhen it should be resolved by, as an ISO 8601 date-time.

    Escalate delivery engagements complaints

    Changes data

    atlas_delivery_engagements_complaints_escalate

    Escalate a complaint to the next level of the firm. Returns the updated complaint.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/complaints/{complaintId}/escalate
    Example prompt
    Escalate the CFO complaint.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    complaintIdstringYesThe complaint id.

    List delivery engagements complaints

    Read only

    atlas_delivery_engagements_complaints_list

    List the client complaints on an engagement with their severity, category, owner, status and target resolution date.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/complaints
    Example prompt
    Are there any open complaints on this engagement?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Create delivery engagements

    Changes data

    atlas_delivery_engagements_create

    Create an engagement for a client account. It starts in the pipeline state; apply a playbook afterwards to set up its phases, deliverables and registers. Returns the new engagement with its id and reference. Use this when a person asks to open or set up a new engagement.

    Scope
    delivery:write
    Calls
    POST /v1/engagements
    Example prompt
    Open a new advisory engagement for the Northwind account.

    Arguments

    FieldTypeRequiredDescription
    accountIdstringYesThe CRM account id of the client.
    codestringYesA short engagement code, unique in the workspace.
    namestringYesThe engagement name.
    type"ADVISORY" | "IMPLEMENTATION" | "MANAGED_SERVICE" | "AUDIT" | "RETAINER" | "DUE_DILIGENCE" | "TRANSFORMATION" | "STAFF_AUGMENTATION" | "TRAINING" | "RESEARCH" | "INTERIM_MANAGEMENT"YesWhat kind of engagement this is.
    feeModel"FIXED" | "TIME_AND_MATERIALS" | "CAPPED_TM" | "RETAINER" | "MILESTONE" | "OUTCOME" | "RISK_REWARD" | "GAIN_SHARE" | "SUBSCRIPTION" | "BLENDED" | "NOT_TO_EXCEED" | "PRO_BONO"YesHow the engagement is charged.
    summarystringNoA short summary of the work.
    currencystringNoThe ISO 4217 currency code, for example USD.
    contractValuestringNoThe contract value, as a decimal string.
    startsOnstring (date-time)NoWhen the engagement starts, as an ISO 8601 UTC date-time.
    endsOnstring (date-time)NoWhen the engagement ends, as an ISO 8601 UTC date-time.
    partnerUserIdstringNoThe member id of the engagement partner.
    managerUserIdstringNoThe member id of the engagement manager.
    confidentiality"STANDARD" | "RESTRICTED" | "HIGHLY_RESTRICTED"NoHow widely the engagement may be seen inside the firm.
    restrictedAccessOnlybooleanNoWhether only named people may see the engagement.

    Get delivery engagements critical path

    Read only

    atlas_delivery_engagements_critical_path_get

    Read the critical path of the plan in the order it runs, as last computed. It does not recompute; use the refresh tool for that.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/plan/critical-path
    Example prompt
    What is on the Northwind critical path?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Refresh delivery engagements critical path

    Changes data

    atlas_delivery_engagements_critical_path_refresh

    Recompute the critical path and the float of every plan item. Returns the new critical path.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/plan/recompute
    Example prompt
    Recompute the Northwind critical path.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Get delivery engagements custom fields

    Read only

    atlas_delivery_engagements_custom_fields_get

    Read the custom field values of one engagement, with the field definitions the workspace uses. Use this before writing values, to learn which keys exist.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/custom-fields
    Example prompt
    What custom fields are set on the Northwind engagement?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Set delivery engagements custom fields

    Changes data

    atlas_delivery_engagements_custom_fields_set

    Write custom field values on one engagement. Only the keys sent are written, and a null clears a value. Returns every value after the write.

    Scope
    delivery:write
    Calls
    PUT /v1/engagements/{engagementId}/custom-fields
    Example prompt
    Set the Northwind sector field to Retail.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    valuesobjectYesThe field values to write, keyed by field key. A null clears a value.

    Create delivery engagements data dispositions

    Changes data

    atlas_delivery_engagements_data_dispositions_create

    Record a client dataset and the client instruction for it at the end of the engagement: its classification, locations, return format and any conflict with the firm retention obligations. Returns the record.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/data-dispositions
    Example prompt
    Record that the client wants the customer extract destroyed, held in two locations.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    datasetDescriptionstringYesWhat the dataset is.
    classificationstringYesThe classification of the dataset, such as CONFIDENTIAL.
    locationsarray of stringYesWhere copies of the dataset are held.
    clientInstructionstringYesWhat the client instructed, such as RETURN or DESTROY.
    conflictWithOurRetentionObligationbooleanNoWhether the client instruction conflicts with a retention obligation of the firm.
    conflictResolutionLegalBasisstringNoThe legal basis on which that conflict is resolved.
    returnFormatstringNoThe format the data is returned in.
    residualCopiesDeclaredstringNoAny copies that remain, declared.
    legalHoldOverridebooleanNoWhether a legal hold overrides the client instruction.

    List delivery engagements data dispositions

    Read only

    atlas_delivery_engagements_data_dispositions_list

    List the data dispositions of an engagement: each client dataset, where it is held, what the client instructed, and whether it has been returned or destroyed.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/data-dispositions
    Example prompt
    What client data do we still hold for this engagement?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    List delivery engagements data dispositions outstanding

    Read only

    atlas_delivery_engagements_data_dispositions_outstanding_list

    List the data dispositions not yet carried out. Use this to answer "what client data must still be returned or destroyed".

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/data-dispositions/outstanding
    Example prompt
    Which client datasets have not been returned or destroyed yet?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Delete delivery engagements

    Destructive

    atlas_delivery_engagements_delete

    Delete an engagement. It leaves every list and its code is released for reuse; the record is kept only for audit. Requires the administrator role. Archive it instead when it should only be put away, and use this only when the person explicitly asks to delete it.

    Scope
    delivery:write
    Calls
    DELETE /v1/engagements/{id}
    Example prompt
    Delete the duplicate Northwind engagement I created by mistake.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Get delivery engagements deliverable certificates

    Read only

    atlas_delivery_engagements_deliverable_certificates_get

    Return the API path of the acceptance certificate for a deliverable, in the format asked for. Compose it with the API base URL and an Authorization header to download the document.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/deliverables/{childId}/acceptance-certificate
    Example prompt
    Get the acceptance certificate for the operating model deliverable as a PDF.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    deliverableIdstringYesThe deliverable id.
    format"pdf" | "xlsx" | "docx" | "md"YesThe document format.
    audience"INTERNAL" | "CLIENT"NoWhich edition: the firm edition, or the client edition. Defaults to the firm edition.

    Create delivery engagements deliverable criteria

    Changes data

    atlas_delivery_engagements_deliverable_criteria_create

    Add an acceptance criterion to a deliverable. Returns the criterion.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/deliverables/{childId}/criteria
    Example prompt
    Add an acceptance criterion that every process has an owner.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    deliverableIdstringYesThe deliverable id.
    statementstringYesThe criterion, in one sentence.
    positionintegerNoWhere it sits in the list, from 0.
    mandatorybooleanNoWhether the criterion must be met for acceptance.
    clientVisiblebooleanNoWhether the client can see this in the portal.

    List delivery engagements deliverable criteria

    Read only

    atlas_delivery_engagements_deliverable_criteria_list

    List the acceptance criteria of a deliverable with whether each is met, not met or waived.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/deliverables/{childId}/criteria
    Example prompt
    Which acceptance criteria on the operating model are still unmet?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    deliverableIdstringYesThe deliverable id.

    List delivery engagements deliverable reviews

    Read only

    atlas_delivery_engagements_deliverable_reviews_list

    List the reviews of a deliverable, one per gate, with their reviewer and outcome.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/deliverables/{childId}/reviews
    Example prompt
    Which reviews has the operating model been through?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    deliverableIdstringYesThe deliverable id.

    Request delivery engagements deliverable reviews

    Changes data

    atlas_delivery_engagements_deliverable_reviews_request

    Request a review of a deliverable at a gate, for example quality review or legal review. Returns the review.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/deliverables/{childId}/reviews
    Example prompt
    Request a quality review of the operating model from Priya.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    deliverableIdstringYesThe deliverable id.
    gate"INTERNAL_REVIEW" | "QA_REVIEW" | "EQ_REVIEW" | "TECHNICAL_REVIEW" | "EDITORIAL_REVIEW" | "LEGAL_REVIEW" | "CLIENT_REVIEW"YesWhich review gate to request.
    reviewerUserIdstringNoThe member id of the reviewer.

    Capture delivery engagements deliverable versions

    Changes data

    atlas_delivery_engagements_deliverable_versions_capture

    Record a new version of a deliverable, with what changed and the file it lives in. Returns the version.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/deliverables/{childId}/versions
    Example prompt
    Record version two of the operating model with this change log.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    deliverableIdstringYesThe deliverable id.
    labelstringNoA short label for the version, for example v2.
    summarystringNoWhat the version contains.
    changeLogstringNoWhat changed since the previous version.
    attachmentIdstringNoThe attachment id of the file.
    storageKeystringNoThe storage key of the file.
    contentHashstringNoThe hash of the content being recorded.

    Create delivery engagements deliverables

    Changes data

    atlas_delivery_engagements_deliverables_create

    Add a deliverable to an engagement, with its due date, owner, review tier and acceptance criteria. Returns the new deliverable.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/deliverables
    Example prompt
    Add the target operating model as a contractual deliverable due in May.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    codestringYesA short reference code, unique within the engagement.
    namestringYesThe deliverable name.
    descriptionstringNoThe detail behind it.
    type"REPORT" | "PRESENTATION" | "MODEL" | "DATASET" | "CODE" | "DESIGN" | "POLICY" | "PROCESS" | "TRAINING" | "PLAN" | "CERTIFICATE" | "ASSESSMENT" | "OPINION" | "OTHER"NoWhat kind of deliverable this is.
    reviewTier"LIGHT" | "STANDARD" | "ENHANCED" | "EQR"NoHow much review the deliverable needs.
    ownerUserIdstringNoThe member id of the owner.
    workstreamIdstringNoThe workstream id.
    dueOnstring (date-time)NoWhen the deliverable is due, as an ISO 8601 UTC date-time.
    contractualbooleanNoWhether the contract names this deliverable.
    classification"PUBLIC" | "INTERNAL" | "CLIENT_CONFIDENTIAL" | "HIGHLY_CONFIDENTIAL"NoThe information classification of the deliverable.
    criteriaarray of stringNoAcceptance criteria to create with the deliverable, one statement each.

    Get delivery engagements deliverables

    Read only

    atlas_delivery_engagements_deliverables_get

    Read one deliverable with its stage, versions, reviews, criteria and sign-off.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/deliverables/{childId}
    Example prompt
    Show me the target operating model deliverable.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    deliverableIdstringYesThe deliverable id.

    List delivery engagements deliverables

    Read only

    atlas_delivery_engagements_deliverables_list

    Read the deliverable register for one engagement: what the firm owes the client, and which review gate each piece is sitting at. Use this to answer "what is late" or "what is waiting on the client". Pass `nextCursor` back as `cursor` for the next page.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/deliverables
    Example prompt
    What deliverables are late on Northwind?

    Arguments

    FieldTypeRequiredDescription
    idstringYesThe engagement id.
    limitintegerNoPage size, 1 to 200.
    cursorstringNoThe nextCursor of the previous page. Leave it out for the first page.

    List delivery engagements differences of opinion

    Read only

    atlas_delivery_engagements_differences_of_opinion_list

    List the differences of opinion on an engagement, resolved ones included: the nature of each, the escalation path used, the resolution and any dissent recorded.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/differences-of-opinion
    Example prompt
    Are there any open differences of opinion on the Acme audit?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Record delivery engagements differences of opinion

    Changes data

    atlas_delivery_engagements_differences_of_opinion_record

    Record a difference of opinion on an engagement, with its nature and the escalation path used. An open difference holds the report date until a person resolves it. Returns the record.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/differences-of-opinion
    Example prompt
    Record a difference of opinion on the revenue recognition judgment, escalated to the technical panel.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    naturestringYesWhat the difference of opinion is about.
    escalationPathUsedstringNoThe escalation path used.

    List delivery engagements document handling

    Read only

    atlas_delivery_engagements_document_handling_list

    List the handling rules recorded for the documents of an engagement: classification, markings, distribution limits, redaction and metadata state, inside information flags, and release state.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/document-handling
    Example prompt
    What are the handling rules on the board paper?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Set delivery engagements document handling

    Changes data

    atlas_delivery_engagements_document_handling_set

    Record or update the handling rules for a document: classification, markings, who may receive it, print and download permissions, DRM, redaction and metadata scrubbing, and inside information flags. Returns the record.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/document-handling
    Example prompt
    Mark the board paper as named recipients only with no download.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    deliverableVersionIdstringNoThe id of the deliverable version the handling rules apply to.
    classificationSchemestringNoThe classification scheme the marking follows.
    clientSchemeOverridestringNoThe client classification, when it replaces the firm one.
    markingLocationsarray of stringNoWhere the classification marking appears, such as header and footer.
    namedRecipientsOnlybooleanNoWhether only named recipients may receive the document.
    onwardDistributionPermittedbooleanNoWhether recipients may pass the document on.
    printPermittedbooleanNoWhether recipients may print it.
    downloadPermittedbooleanNoWhether recipients may download it.
    drmAppliedbooleanNoWhether rights management is applied.
    watermarkDynamicbooleanNoWhether each copy carries a watermark naming its recipient.
    accessExpiresAtstring (date-time)NoWhen recipient access to the document expires, as an ISO 8601 date-time in UTC.
    redactionAppliedbooleanNoWhether redaction has been applied.
    redactionLayerFlattenedbooleanNoWhether the redaction layer has been flattened so it cannot be removed.
    metadataScrubbedbooleanNoWhether document metadata has been scrubbed.
    metadataScrubEvidenceIdstringNoThe id of the attachment that evidences the metadata scrub.
    filePasswordbooleanNoWhether the file is password protected.
    passwordChannelSeparatebooleanNoWhether the password is sent by a separate channel.
    mnpiFlagbooleanNoWhether the document holds material non-public information.
    insiderListEntryRequiredbooleanNoWhether recipients must be entered on an insider list.
    recallProcessstringNoHow the document is recalled if it must be.
    withdrawalNoticeRequiredbooleanNoWhether recipients must be sent a withdrawal notice on recall.

    Withdraw delivery engagements document handling

    Changes data

    atlas_delivery_engagements_document_handling_withdraw

    Recall a released document, with the reason, so recipients are told to stop using it. Returns the updated record.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/document-handling/{childId}/recall
    Example prompt
    Recall the board paper, it went out with the wrong figures.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    handlingIdstringYesThe document handling record id.
    reasonstringYesWhy the document is recalled.

    Create delivery engagements escalation paths

    Changes data

    atlas_delivery_engagements_escalation_paths_create

    Add a level to the escalation path of an engagement, with its trigger, response time, and the firm and client people at that level. Returns the created level.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/escalation-paths
    Example prompt
    Add a level 3 escalation to the client CFO with a 24 hour response.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    levelintegerYesThe escalation level this row defines, from 1 to 10.
    descriptionstringYesWho is at this level and what they decide, in one line.
    triggerConditionstringNoThe condition that escalates to this level.
    responseSlaHoursintegerNoHow many hours people at this level have to respond.
    firmUserIdstringNoThe Atlas user id of the firm-side person.
    clientContactIdstringNoThe CRM contact id of the client-side person.
    notifyChannelsarray of stringNoThe channels used to notify people at this level.

    List delivery engagements escalation paths

    Read only

    atlas_delivery_engagements_escalation_paths_list

    List the escalation paths of an engagement: each level with its description, trigger, response time and the firm and client people at that level.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/escalation-paths
    Example prompt
    Who do we escalate to at level 2 on this engagement?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Create delivery engagements expenses

    Changes data

    atlas_delivery_engagements_expenses_create

    Record an expense against an engagement, as a draft. Returns the expense.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/commercials/expenses
    Example prompt
    Record a 240 pound train fare to the client site yesterday.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    incurredOnstring (date-time)YesWhen the expense was incurred, as an ISO 8601 UTC date-time.
    category"TRAVEL" | "ACCOMMODATION" | "SUBSISTENCE" | "MILEAGE" | "SUBCONTRACTOR" | "SOFTWARE" | "DATA" | "PRINTING" | "ENTERTAINMENT" | "OTHER"NoWhat kind of expense this is.
    descriptionstringYesWhat the expense was for.
    amountstringYesThe amount, as a decimal string with at most two places.
    currencystringNoThe ISO 4217 currency code, for example USD.
    fxRatestringNoThe exchange rate to the engagement currency, as a decimal string.
    billablebooleanNoWhether the expense is billed to the client.
    markupPercentstringNoThe markup applied when the expense is billed, as a percentage string.
    clientVisiblebooleanNoWhether the client can see this in the portal.
    policyBreachbooleanNoWhether the expense breaches the expense policy.
    policyBreachReasonstringNoWhy the expense breaches the policy.
    perDiemAppliedbooleanNoWhether a per diem rate was applied.
    mileageKmstringNoThe distance travelled in kilometres, as a decimal string.
    receiptAttachmentIdstringNoThe attachment id of the receipt.
    disbursementVsRecharge"DISBURSEMENT" | "RECHARGE"NoWhether the cost is a disbursement or a recharge.
    invoiceAddressedTostringNoWho the supplier invoice was addressed to.
    clientAuthorisedInAdvancebooleanNoWhether the client authorised the expense in advance.
    passedOnAtCostbooleanNoWhether the cost is passed on at cost.
    separatelyItemisedbooleanNoWhether the cost is itemised separately on the invoice.
    carbonKgstringNoThe carbon emitted, in kilograms, as a decimal string.

    Disburse delivery engagements expenses

    Destructive

    atlas_delivery_engagements_expenses_disburse

    Record that an approved expense was reimbursed to the person who paid it. Returns the expense.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/commercials/expenses/{childId}/reimburse
    Example prompt
    Record that the train fare was reimbursed.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    expenseIdstringYesThe expense id.

    List delivery engagements expenses

    Read only

    atlas_delivery_engagements_expenses_list

    List the expenses of one engagement, with filters for status, billable and policy breaches.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/commercials/expenses
    Example prompt
    Which Northwind expenses breach the policy?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    status"DRAFT" | "SUBMITTED" | "APPROVED" | "REJECTED" | "REIMBURSED" | "BILLED" | "WRITTEN_OFF"NoFilter to one expense state.
    billablebooleanNoFilter to billable or non-billable expenses.
    policyBreachbooleanNoFilter to expenses that breach, or do not breach, the policy.
    limitintegerNoPage size (1..500).

    Submit delivery engagements expenses

    Changes data

    atlas_delivery_engagements_expenses_submit

    Submit a draft expense for approval. A submitted expense cannot be edited until it is rejected back. Returns the expense.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/commercials/expenses/{childId}/submit
    Example prompt
    Submit my train fare expense for approval.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    expenseIdstringYesThe expense id.

    Update delivery engagements expenses

    Changes data

    atlas_delivery_engagements_expenses_update

    Change a draft expense. Send only the fields that change. Returns the expense.

    Scope
    delivery:write
    Calls
    PATCH /v1/engagements/{engagementId}/commercials/expenses/{childId}
    Example prompt
    Mark the train fare as billable.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    expenseIdstringYesThe expense id.
    incurredOnstring (date-time)NoWhen the expense was incurred, as an ISO 8601 UTC date-time.
    category"TRAVEL" | "ACCOMMODATION" | "SUBSISTENCE" | "MILEAGE" | "SUBCONTRACTOR" | "SOFTWARE" | "DATA" | "PRINTING" | "ENTERTAINMENT" | "OTHER"NoWhat kind of expense this is.
    descriptionstringNoWhat the expense was for.
    amountstringNoThe amount, as a decimal string with at most two places.
    currencystringNoThe ISO 4217 currency code, for example USD.
    fxRatestringNoThe exchange rate to the engagement currency, as a decimal string.
    billablebooleanNoWhether the expense is billed to the client.
    markupPercentstringNoThe markup applied when the expense is billed, as a percentage string.
    clientVisiblebooleanNoWhether the client can see this in the portal.
    policyBreachbooleanNoWhether the expense breaches the expense policy.
    policyBreachReasonstringNoWhy the expense breaches the policy.
    perDiemAppliedbooleanNoWhether a per diem rate was applied.
    mileageKmstringNoThe distance travelled in kilometres, as a decimal string.
    receiptAttachmentIdstringNoThe attachment id of the receipt.
    disbursementVsRecharge"DISBURSEMENT" | "RECHARGE"NoWhether the cost is a disbursement or a recharge.
    invoiceAddressedTostringNoWho the supplier invoice was addressed to.
    clientAuthorisedInAdvancebooleanNoWhether the client authorised the expense in advance.
    passedOnAtCostbooleanNoWhether the cost is passed on at cost.
    separatelyItemisedbooleanNoWhether the cost is itemised separately on the invoice.
    carbonKgstringNoThe carbon emitted, in kilograms, as a decimal string.

    Complete delivery engagements expert calls

    Changes data

    atlas_delivery_engagements_expert_calls_complete

    Record that an approved expert call took place, with its duration, attendees and notes attachment. Returns the updated call.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/expert-calls/{callId}/hold
    Example prompt
    Record that the expert call happened, 45 minutes, with Sam and Priya.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    callIdstringYesThe expert call id.
    durationMinintegerNoHow long the call lasted, in minutes.
    attendeesarray of stringNoThe names or user ids of the people who attended.
    notesAttachmentIdstringNoThe id of the attachment that holds the call notes.

    Get delivery engagements expert calls

    Read only

    atlas_delivery_engagements_expert_calls_get

    Read one expert call in full, including its compliance review, attestation and incident record.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/expert-calls/{callId}
    Example prompt
    Show me the supplier pricing expert call.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    callIdstringYesThe expert call id.

    Create delivery engagements expert calls incidents

    Changes data

    atlas_delivery_engagements_expert_calls_incidents_create

    Flag a compliance incident on an expert call, such as a call ended early because the expert began to share restricted information. Returns the updated call.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/expert-calls/{callId}/incident
    Example prompt
    Flag an incident on the call: it was stopped when the expert mentioned current pricing.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    callIdstringYesThe expert call id.
    terminatedEarlyReasonstringNoWhat happened, including why the call was ended early if it was.

    List delivery engagements expert calls incidents

    Read only

    atlas_delivery_engagements_expert_calls_incidents_list

    List expert calls with an open compliance incident, such as a call terminated early for sharing restricted information.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/expert-calls/open-incidents
    Example prompt
    Are there any open expert call incidents?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    List delivery engagements expert calls

    Read only

    atlas_delivery_engagements_expert_calls_list

    List the expert network calls on an engagement with their network, topic, compliance state and status.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/expert-calls
    Example prompt
    Which expert calls are waiting for compliance approval?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Request delivery engagements expert calls

    Changes data

    atlas_delivery_engagements_expert_calls_request

    Request an expert network call: the network, expert reference, topic, hypotheses it tests, justification, the expert role history and compliance flags. It then waits for compliance review and approval. Returns the call.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/expert-calls
    Example prompt
    Request a call with a former procurement director from the GLG network about supplier pricing.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    networkstringYesThe expert network the call is booked through.
    expertRefstringYesThe expert network reference for the expert.
    topicstringYesWhat the call is about.
    hypothesisIdsarray of stringNoThe ids of the hypotheses the call tests.
    justificationstringNoWhy the call is needed.
    expertRoleHistorystringNoThe roles the expert has held that bear on the topic.
    currentEmployerstringNoThe current employer of the expert.
    formerEmployerstringNoThe former employer of the expert.
    leftRoleAtstring (date-time)NoWhen the expert left the relevant role, as an ISO 8601 date-time in UTC.
    complianceFlagsarray of stringNoCompliance concerns raised when requesting the call.
    chaperoneIdstringNoThe Atlas user id of the compliance chaperone for the call.
    paymentRoutestringNoHow the expert is paid.

    Update delivery engagements expert calls

    Changes data

    atlas_delivery_engagements_expert_calls_update

    Change an expert call: its topic, justification, employer history, compliance flags, chaperone, attestation and script status, or notes attachment. Only the fields sent change. Returns the updated call.

    Scope
    delivery:write
    Calls
    PATCH /v1/engagements/{engagementId}/expert-calls/{callId}
    Example prompt
    Record that the expert attestation has been obtained.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    callIdstringYesThe expert call id.
    topicstringNoWhat the call is about.
    justificationstringNoWhy the call is needed.
    expertRoleHistorystringNoThe roles the expert has held that bear on the topic.
    currentEmployerstring | nullNoThe current employer of the expert, or null to clear it.
    formerEmployerstring | nullNoThe former employer of the expert, or null to clear it.
    complianceFlagsarray of stringNoCompliance concerns on the call.
    chaperoneIdstring | nullNoThe Atlas user id of the compliance chaperone, or null to clear it.
    notesAttachmentIdstringNoThe id of the attachment that holds the call notes.

    Create delivery engagements export jobs

    Changes data

    atlas_delivery_engagements_export_jobs_create

    Request an export artifact as a background job in PDF, Word, Excel or Markdown. Returns the job; poll it with atlas_delivery_engagements_export_jobs_get and fetch it with atlas_delivery_engagements_export_jobs_download. The economics summary is refused, because it carries cost rates and margin.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/exports/jobs
    Example prompt
    Export the RAID log as a PDF.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    artifactstringYesThe export artifact key, as returned by atlas_delivery_engagements_exports_list.
    format"pdf" | "docx" | "xlsx" | "md"YesThe output format: pdf, docx, xlsx or md.
    audience"INTERNAL" | "CLIENT"NoWho the output is for: INTERNAL shows everything, CLIENT shows only what may be shared with the client.
    subjectIdstringNoThe id of the one record the artifact is about, for an artifact that needs one.

    Download delivery engagements export jobs

    Read only

    atlas_delivery_engagements_export_jobs_download

    Issue the one-time download link for a ready export job. The link is spent when issued, so a second call returns 410 and a fresh export is needed. The job is read first, and a job for the economics summary is refused, because it carries cost rates and margin.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/exports/jobs/{jobId}
    GET /v1/engagements/{engagementId}/exports/jobs/{jobId}/download
    Example prompt
    Give me the link to download the RAID PDF.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    jobIdstringYesThe export job id.

    Get delivery engagements export jobs

    Read only

    atlas_delivery_engagements_export_jobs_get

    Read the status of one export job: queued, running, ready or failed, and when a ready artifact expires. Use this to poll a job before downloading it.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/exports/jobs/{jobId}
    Example prompt
    Is the RAID PDF ready?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    jobIdstringYesThe export job id.

    List delivery engagements export jobs

    Read only

    atlas_delivery_engagements_export_jobs_list

    List the export jobs the person has requested on this engagement, newest first, with their status.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/exports/jobs
    Example prompt
    Are my exports ready?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    List delivery engagements exports

    Read only

    atlas_delivery_engagements_exports_list

    List the export artifacts an engagement offers, with the formats each supports and whether it has a client variant. The economics summary is left out, because it carries cost rates and margin.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/exports
    Example prompt
    What documents can I export from this engagement?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Render delivery engagements exports

    Read only

    atlas_delivery_engagements_exports_render

    Render one export artifact as a Markdown document, for the internal team or in the client-safe form. Returns the Markdown text, or a job ticket when the artifact is too large to render in one request. For PDF, Word or Excel, use atlas_delivery_engagements_export_jobs_create. The economics summary is refused, because it carries cost rates and margin.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/exports/{artifact}
    Example prompt
    Give me the stakeholder map as Markdown.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    artifactstringYesThe export artifact key, as returned by atlas_delivery_engagements_exports_list.
    audience"INTERNAL" | "CLIENT"NoWho the output is for: INTERNAL shows everything, CLIENT shows only what may be shared with the client.
    subjectstringNoThe id of the one record the artifact is about, for an artifact that needs one.

    Calculate delivery engagements fee caps

    Read only

    atlas_delivery_engagements_fee_caps_calculate

    Calculate the audit independence fee caps for an engagement: the non-audit fee cap against the three-year audit fee average and the fee dependency threshold. Use this before taking on non-audit work for an audit client.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/fee-caps
    Example prompt
    How much non-audit work can we take on for this audit client?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    auditFeesThreeYearnumberNoThe average audit fee over the last three years, used as the base of the cap.
    totalFeeDependencyPercentnumberNoThe share of total firm fees that come from this client, as a percentage.
    publicInterestEntitybooleanNoWhether the client is a public interest entity, which tightens the caps.

    Record delivery engagements feedback consent

    Changes data

    atlas_delivery_engagements_feedback_consent_record

    Record whether the respondent consents to be quoted and to act as a reference. Returns the updated feedback.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/feedback/{feedbackId}/consent
    Example prompt
    The sponsor is happy to be quoted but not to be a reference.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    feedbackIdstringYesThe feedback request id.
    consentToQuotebooleanNoWhether the respondent consents to being quoted.
    consentToReferencebooleanNoWhether the respondent consents to acting as a reference.

    Complete delivery engagements feedback follow ups

    Changes data

    atlas_delivery_engagements_feedback_follow_ups_complete

    Record that the follow-up conversation on a feedback response has happened. Returns the updated feedback.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/feedback/{feedbackId}/follow-up-complete
    Example prompt
    Mark the follow-up call on the low score as done.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    feedbackIdstringYesThe feedback request id.

    List delivery engagements feedback follow ups

    Read only

    atlas_delivery_engagements_feedback_follow_ups_list

    List feedback responses that need a follow-up conversation, such as a low score, and who owns each.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/feedback/follow-up
    Example prompt
    Which feedback responses still need a follow-up call?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    List delivery engagements feedback

    Read only

    atlas_delivery_engagements_feedback_list

    List the feedback requests and responses on an engagement: kind, respondent, score, verbatim and themes.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/feedback
    Example prompt
    What feedback has the client given on this engagement?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    List delivery engagements feedback quotable

    Read only

    atlas_delivery_engagements_feedback_quotable_list

    List feedback the respondent has consented to have quoted, for use in proposals and case studies.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/feedback/quotable
    Example prompt
    Which client quotes are we allowed to use?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Request delivery engagements feedback

    Changes data

    atlas_delivery_engagements_feedback_request

    Ask for feedback on an engagement: the kind of survey, the respondent, the themes and the milestone that triggered it. Returns the feedback request.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/feedback
    Example prompt
    Ask the client sponsor for an NPS score after phase one.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    kind"CSAT" | "NPS" | "CES" | "PULSE" | "EXIT_INTERVIEW" | "COMPLAINT" | "COMPLIMENT"YesThe kind of survey or feedback.
    respondentPartyType"USER" | "CLIENT_CONTACT" | "EXTERNAL"YesWho is asked for feedback: an Atlas user, a client contact, or an external person.
    respondentContactIdstringNoThe CRM contact id of the respondent, when the respondent is a client contact.
    respondentLabelstringNoA display name for the respondent, when there is no contact record.
    themesarray of stringNoThe themes the request asks about.
    milestoneTriggerstringNoThe milestone that prompted the request, such as PHASE_1_COMPLETE.
    anonymousbooleanNoWhether the response is anonymous.

    Record delivery engagements feedback responses

    Changes data

    atlas_delivery_engagements_feedback_responses_record

    Record the response to a feedback request: the score, verbatim comment, themes and the owner of any follow-up. Returns the updated feedback.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/feedback/{feedbackId}/response
    Example prompt
    Record a score of 9 from the sponsor with the comment "excellent team".

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    feedbackIdstringYesThe feedback request id.
    scoreinteger | nullNoThe score, from 0 to 10, or null when none was given.
    verbatimstringNoThe comment in the respondent own words.
    themesarray of stringNoTheme tags drawn from the response.
    followUpOwnerUserIdstringNoThe Atlas user id of the person who owns the follow-up.

    List delivery engagements financial snapshots

    Read only

    atlas_delivery_engagements_financial_snapshots_list

    Read the frozen financial snapshots of one engagement, newest first and at most 200. A snapshot keeps the figures as they stood on a day, so a number quoted to a client stays quotable after a timesheet is corrected. Use this to answer "what did the numbers say at the last report".

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/commercials/snapshots
    Example prompt
    What did the Northwind numbers say at the end of last month?

    Arguments

    FieldTypeRequiredDescription
    idstringYesThe engagement id.

    Acknowledge delivery engagements follow ups

    Changes data

    atlas_delivery_engagements_follow_ups_acknowledge

    Acknowledge a follow-up, recording that the assignee has seen it. Reminders continue until it is completed. Returns the updated follow-up.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/follow-ups/{followUpId}/acknowledge
    Example prompt
    Acknowledge the reminder about the status report.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    followUpIdstringYesThe follow-up id.

    Cancel delivery engagements follow ups

    Destructive

    atlas_delivery_engagements_follow_ups_cancel

    Cancel a follow-up so no further reminders are sent. Returns the cancelled follow-up.

    Scope
    delivery:write
    Calls
    DELETE /v1/engagements/{engagementId}/follow-ups/{followUpId}
    Example prompt
    Cancel the reminder about the kickoff pack.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    followUpIdstringYesThe follow-up id.

    Complete delivery engagements follow ups

    Changes data

    atlas_delivery_engagements_follow_ups_complete

    Complete a follow-up. A repeating follow-up schedules its next occurrence. Returns the updated follow-up.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/follow-ups/{followUpId}/complete
    Example prompt
    Mark the chase for the signed SOW as done.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    followUpIdstringYesThe follow-up id.

    Create delivery engagements follow ups

    Changes data

    atlas_delivery_engagements_follow_ups_create

    Create a follow-up on an engagement: a reminder or chase for a person, about a record, due at a time, optionally repeating and escalating after missed reminders. Returns the created follow-up.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/follow-ups
    Example prompt
    Remind the client sponsor every Monday to confirm the steering attendees.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    kind"ACTION_ITEM" | "RAID_REVIEW" | "DELIVERABLE_DUE" | "MEETING_PREP" | "DECISION_EXPIRY" | "THREAD_SLA" | "STATUS_REPORT_DUE" | "SIGNOFF_CHASE" | "STAKEHOLDER_TOUCH" | "INFO_REQUEST_CHASE" | "ASSUMPTION_VALIDATION" | "CONTRACT_MILESTONE" | "HYPERCARE_CHECK" | "BENEFIT_REVIEW" | "CUSTOM"YesWhat the follow-up is for.
    titlestringYesWhat the reminder says, in one line.
    bodystringNoThe reminder text.
    assigneePartyType"USER" | "CLIENT_CONTACT" | "EXTERNAL"YesWho it is assigned to: an Atlas user, a client contact, or an external person.
    assigneeUserIdstringNoThe Atlas user id of the assignee, when the assignee is a user.
    assigneeContactIdstringNoThe CRM contact id of the assignee, when the assignee is a client contact.
    assigneeEmailstring (email)NoThe email address of the assignee, when the assignee is external.
    ccUserIdsarray of stringNoAtlas user ids of people to copy on each reminder.
    subjectType"PHASE" | "WORKSTREAM" | "OBJECTIVE" | "SCOPE_STATEMENT" | "DELIVERABLE" | "PLAN_ITEM" | "RAID_ITEM" | "MEETING" | "MEETING_SERIES" | "THREAD" | "INFO_REQUEST" | "CHANGE_REQUEST" | "STATUS_REPORT" | "STAKEHOLDER" | "BILLING_MILESTONE" | "SIGN_OFF" | "CHECK" | "LEGAL_INSTRUMENT" | "CLOSURE_ITEM" | "BENEFIT" | "ACCESS_PROVISION" | "COMMERCIAL_TERM" | "ANALYTICAL_ASSUMPTION" | "RESPONSIBILITY_AREA" | "FOLLOW_UP" | "CLIENT_PROCUREMENT" | "ENGAGEMENT"NoThe kind of engagement record it is about.
    subjectIdstringNoThe id of the engagement record it is about.
    subjectLabelstringNoA readable label for the record it is about.
    dueAtstringNoWhen it is due, as an ISO 8601 date-time.
    leadMinutesintegerNoHow many minutes before the due time the first reminder is sent.
    recurrenceRuleobjectNoHow the follow-up repeats. Leave it out for a one-off follow-up.
    channelsarray of "inapp" | "email"NoWhere reminders are delivered: in the app, by email, or both.
    escalateAfterMissesintegerNoHow many missed reminders trigger an escalation.
    escalateToUserIdstringNoThe Atlas user id of the person to escalate to after repeated misses.
    escalationPathIdstringNoThe id of an escalation path defined on this engagement.

    List delivery engagements follow ups due

    Read only

    atlas_delivery_engagements_follow_ups_due_list

    List follow-ups falling due within the given number of days. Use this to answer "what needs chasing this week".

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/follow-ups/due
    Example prompt
    What follow-ups are due in the next three days?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    daysintegerNoHow many days ahead to look.

    Get delivery engagements follow ups

    Read only

    atlas_delivery_engagements_follow_ups_get

    Read one follow-up in full, including its schedule, recurrence, channels and escalation settings.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/follow-ups/{followUpId}
    Example prompt
    Show me the steering attendees reminder.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    followUpIdstringYesThe follow-up id.

    List delivery engagements follow ups

    Read only

    atlas_delivery_engagements_follow_ups_list

    List the follow-ups on an engagement: reminders and chases with their assignee, subject, due time, recurrence and state.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/follow-ups
    Example prompt
    What follow-ups are set on this engagement?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    List delivery engagements follow ups mine

    Read only

    atlas_delivery_engagements_follow_ups_mine_list

    List the follow-ups on an engagement that are assigned to the person the token belongs to.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/follow-ups/mine
    Example prompt
    What follow-ups do I own on this engagement?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Pause delivery engagements follow ups

    Changes data

    atlas_delivery_engagements_follow_ups_pause

    Pause a follow-up so no reminders are sent until it is resumed. Returns the updated follow-up.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/follow-ups/{followUpId}/pause
    Example prompt
    Pause the weekly reminder while the client is on holiday.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    followUpIdstringYesThe follow-up id.

    Resume delivery engagements follow ups

    Changes data

    atlas_delivery_engagements_follow_ups_resume

    Resume a paused follow-up, so its reminders are sent again on schedule. Returns the updated follow-up.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/follow-ups/{followUpId}/resume
    Example prompt
    Resume the weekly reminder.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    followUpIdstringYesThe follow-up id.

    List delivery engagements follow ups runs

    Read only

    atlas_delivery_engagements_follow_ups_runs_list

    Read the delivery history of one follow-up: every reminder sent, on which channel, and whether it was acknowledged or escalated.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/follow-ups/{followUpId}/runs
    Example prompt
    Has the client sponsor been reminded about this yet?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    followUpIdstringYesThe follow-up id.

    Snooze delivery engagements follow ups

    Changes data

    atlas_delivery_engagements_follow_ups_snooze

    Snooze a follow-up until a given time. Returns the updated follow-up.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/follow-ups/{followUpId}/snooze
    Example prompt
    Snooze the invoice chase until next Tuesday.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    followUpIdstringYesThe follow-up id.
    untilstringYesWhen the reminder should come back, as an ISO 8601 date-time.

    Update delivery engagements follow ups

    Changes data

    atlas_delivery_engagements_follow_ups_update

    Change a follow-up: its title, body, subject label, due time, lead time, channels or escalation. Only the fields sent change; send null to clear a field. Returns the updated follow-up.

    Scope
    delivery:write
    Calls
    PATCH /v1/engagements/{engagementId}/follow-ups/{followUpId}
    Example prompt
    Move the invoice chase to Thursday.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    followUpIdstringYesThe follow-up id.
    titlestringNoA short title, in one line.
    bodystring | nullNoThe reminder text, or null to clear it.
    subjectLabelstring | nullNoA readable label for the record it is about, or null to clear it.
    dueAtstring | nullNoWhen it is due, as an ISO 8601 date-time, or null to clear it.
    leadMinutesintegerNoHow many minutes before the due time the first reminder is sent.
    channelsarray of "inapp" | "email"NoWhere reminders are delivered: in the app, by email, or both.
    escalateAfterMissesinteger | nullNoHow many missed reminders trigger an escalation, or null to stop escalating.
    escalateToUserIdstring | nullNoThe Atlas user id of the person to escalate to, or null to clear it.

    Get delivery engagements

    Read only

    atlas_delivery_engagements_get

    Read one engagement: its reference, client, lifecycle state, the seven health ratings, dates, contract value and approved change value. The contract value and the approved change are separate figures; the total is their sum.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{id}
    Example prompt
    Show me the Northwind transformation engagement.

    Arguments

    FieldTypeRequiredDescription
    idstringYesThe engagement id.

    Request delivery engagements handoff information

    Changes data

    atlas_delivery_engagements_handoff_information_request

    Ask sales for more information on a submitted handoff, with the detail needed. Returns the updated handoff.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/handoff/request-info
    Example prompt
    Ask sales to clarify what "light touch PMO" means in the handoff.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    detailstringYesWhat sales needs to clarify.

    Get delivery engagements health history

    Read only

    atlas_delivery_engagements_health_history_get

    Read how the health score of one engagement has moved over time. The live score is overwritten every hour, so use this to answer "has anything moved" rather than "how is it today".

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/metrics/health-history
    Example prompt
    Has the Northwind health score moved over the last month?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    sincestringNoThe earliest date to include, YYYY-MM-DD.

    Create delivery engagements hypotheses

    Changes data

    atlas_delivery_engagements_hypotheses_create

    Add a question or hypothesis to the engagement tree, optionally under a parent. Returns the created hypothesis.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/structuring/hypotheses
    Example prompt
    Add a hypothesis under the growth question: pricing is below the market.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    statementstringYesThe question or hypothesis, in one sentence.
    kind"QUESTION" | "HYPOTHESIS"NoWhether it is a question or a hypothesis.
    parentHypothesisIdstringNoThe id of the parent hypothesis in the tree.
    rationalestringNoThe reasoning behind it.
    ownerUserIdstringNoThe Atlas user id of the person who owns it.
    workstreamIdstringNoThe id of the engagement workstream it belongs to.
    confidenceintegerNoConfidence as a percentage, from 0 to 100.
    isMecebooleanNoWhether the children of this node are mutually exclusive and collectively exhaustive.
    meceNotestringNoWhy the children are, or are not, mutually exclusive and collectively exhaustive.
    testBystring (date-time)NoWhen the hypothesis should be tested by, as an ISO 8601 date-time in UTC.
    isDayOneAnswerbooleanNoWhether this is the day-one answer the team starts from.

    List delivery engagements hypotheses

    Read only

    atlas_delivery_engagements_hypotheses_list

    List the questions and hypotheses on an engagement, optionally by kind, status or tree path, flat rather than as a tree.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/structuring/hypotheses
    Example prompt
    Which hypotheses are still being tested?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    kind"QUESTION" | "HYPOTHESIS"NoOnly questions or only hypotheses.
    status"PROPOSED" | "TESTING" | "SUPPORTED" | "PARTIALLY_SUPPORTED" | "REFUTED" | "INCONCLUSIVE" | "PARKED" | "SUPERSEDED"NoFilter to one status.
    underPathstringNoOnly hypotheses under this tree path.
    limitintegerNoThe largest number of rows to return.

    Move delivery engagements hypotheses

    Changes data

    atlas_delivery_engagements_hypotheses_move

    Move a hypothesis to a different parent, or to the top level with a null parent, at a position among its siblings. Returns the updated hypothesis.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/structuring/hypotheses/{childId}/move
    Example prompt
    Move the channel hypothesis under the growth question.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    hypothesisIdstringYesThe hypothesis id.
    parentHypothesisIdstring | nullYesThe id of the new parent, or null to move it to the top level.
    positionintegerNoThe position among its new siblings, counting from 0.

    Resolve delivery engagements hypotheses

    Changes data

    atlas_delivery_engagements_hypotheses_resolve

    Conclude a hypothesis as supported, partially supported, refuted or inconclusive, with the conclusion. A concluded leaf with no completed analysis behind it is flagged in the tree. Returns the updated hypothesis.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/structuring/hypotheses/{childId}/conclude
    Example prompt
    Conclude the pricing hypothesis as supported.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    hypothesisIdstringYesThe hypothesis id.
    status"SUPPORTED" | "PARTIALLY_SUPPORTED" | "REFUTED" | "INCONCLUSIVE"YesThe conclusion reached.
    conclusionstringYesWhat the evidence showed.
    confidenceintegerNoConfidence as a percentage, from 0 to 100.

    Update delivery engagements hypotheses

    Changes data

    atlas_delivery_engagements_hypotheses_update

    Change the statement, rationale, owner, confidence or other fields of a hypothesis. Only the fields sent change; send null to clear a field that allows it. Returns the updated hypothesis.

    Scope
    delivery:write
    Calls
    PATCH /v1/engagements/{engagementId}/structuring/hypotheses/{childId}
    Example prompt
    Raise the confidence on the pricing hypothesis to 70.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    hypothesisIdstringYesThe hypothesis id.
    statementstringNoThe question or hypothesis, in one sentence.
    rationalestringNoThe reasoning behind it.
    ownerUserIdstring | nullNoThe Atlas user id of the owner, or null to clear it.
    workstreamIdstring | nullNoThe id of the workstream, or null to clear it.
    confidenceintegerNoConfidence as a percentage, from 0 to 100.
    isMecebooleanNoWhether the children of this node are mutually exclusive and collectively exhaustive.
    meceNotestringNoWhy the children are, or are not, mutually exclusive and collectively exhaustive.
    testBystring (date-time)NoWhen the hypothesis should be tested by, as an ISO 8601 date-time in UTC.
    isDayOneAnswerbooleanNoWhether this is the day-one answer the team starts from.

    Get delivery engagements hypothesis tree

    Read only

    atlas_delivery_engagements_hypothesis_tree_get

    The hypothesis tree with its advisory violations. The violation worth acting on is a concluded leaf with no completed analysis behind it, which is a conclusion with no evidence.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/structuring/hypotheses/tree
    Example prompt
    Which hypotheses are still untested?

    Arguments

    FieldTypeRequiredDescription
    idstringYesThe engagement id.

    List delivery engagements independence declarations

    Read only

    atlas_delivery_engagements_independence_declarations_list

    List the independence declarations on an engagement: who declared, the declaration type, the restricted entity list version, any breach identified with its remedial action, and who confirmed it.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/independence-declarations
    Example prompt
    Has everyone on the audit team made an independence declaration?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Record delivery engagements independence declarations

    Changes data

    atlas_delivery_engagements_independence_declarations_record

    Record an independence declaration a named person has made on an engagement, including any breach they identified and the remedial action. Record only what the person declared; the caller is recorded as the one who confirmed it. Returns the declaration.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/independence-declarations
    Example prompt
    Record Priya's engagement-specific independence declaration: no breach identified.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    personIdstringYesThe Atlas user id of the person who made the declaration.
    declarationType"ANNUAL" | "ENGAGEMENT_SPECIFIC" | "EVENT_TRIGGERED"YesThe kind of declaration.
    restrictedEntityListVersionstringNoThe version of the restricted entity list the person declared against.
    breachIdentifiedbooleanNoWhether the person declared a breach.
    breachDetailstringNoThe detail of the breach.
    remedialActionstringNoThe action taken to remedy it.
    communicatedToGovernancebooleanNoWhether the breach was communicated to those charged with governance.

    Link delivery engagements info requests attachments

    Changes data

    atlas_delivery_engagements_info_requests_attachments_link

    Link an attachment already uploaded to Atlas to an information request, as evidence provided against it. Returns the link.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/info-requests/{childId}/attachments
    Example prompt
    Attach the file I uploaded to the bank statements request.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    infoRequestIdstringYesThe information request id.
    attachmentIdstringYesThe id of an attachment already uploaded to Atlas.

    List delivery engagements info requests attachments

    Read only

    atlas_delivery_engagements_info_requests_attachments_list

    List the files attached to an information request, which is what the client has provided against it.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/info-requests/{childId}/attachments
    Example prompt
    What files has the client uploaded for the tax request?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    infoRequestIdstringYesThe information request id.

    Create delivery engagements info requests in bulk

    Changes data

    atlas_delivery_engagements_info_requests_bulk_create

    Add up to two hundred information requests to an engagement in one request, optionally all under one category. Either every request is created or none is. Returns the created requests.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/info-requests/bulk
    Example prompt
    Add this list of twenty data requests to the engagement.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    requestsarray of objectYesThe requests to add, up to two hundred.
    categorystringNoA category applied to every request that does not name its own.

    Cancel delivery engagements info requests

    Destructive

    atlas_delivery_engagements_info_requests_cancel

    Withdraw an information request that is no longer needed, with the reason. The client stops being chased for it. Returns the updated request.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/info-requests/{childId}/cancel
    Example prompt
    Cancel the request for the old org chart, we no longer need it.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    infoRequestIdstringYesThe information request id.
    reasonstringYesWhy, in words a reviewer can read later.

    Create delivery engagements info requests

    Changes data

    atlas_delivery_engagements_info_requests_create

    Add an information request to an engagement: what is asked of the client, in what format, by when, and whether it blocks the plan. It is created unsent; send it with atlas_delivery_engagements_info_requests_send. Returns the created request.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/info-requests
    Example prompt
    Ask the client for the last three years of management accounts by the 14th.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    titlestringYesA short title, in one line.
    descriptionstringNoThe detail behind it.
    categorystringNoA free-text category used to group requests, such as Finance.
    format"DOCUMENT" | "SPREADSHEET" | "DATA_EXTRACT" | "SYSTEM_ACCESS" | "INTERVIEW" | "WALKTHROUGH" | "CONFIRMATION" | "OTHER"NoThe form the client should provide it in.
    periodstringNoThe period the information covers, such as FY2025.
    priority"LOW" | "MEDIUM" | "HIGH" | "CRITICAL"NoHow urgent it is.
    dueAtstring (date-time)NoWhen it is due, as an ISO 8601 date-time in UTC.
    requestedOfPartyType"USER" | "CLIENT_CONTACT" | "EXTERNAL"NoWho is asked: an Atlas user, a client contact, or an external person.
    requestedOfContactIdstringNoThe CRM contact id of the client contact who is asked.
    requestedOfLabelstringNoA display name for the person asked, when there is no contact record.
    ownerUserIdstringNoThe Atlas user id of the person who owns it.
    workstreamIdstringNoThe id of the engagement workstream it belongs to.
    blockingbooleanNoWhether the plan cannot proceed without it.
    blocksPlanItemIdstringNoThe id of the plan item this request blocks.
    itemsarray of stringNoChecklist item labels to add to the request, up to fifty.

    Delete delivery engagements info requests

    Destructive

    atlas_delivery_engagements_info_requests_delete

    Delete an information request that was added in error and never sent. A request the client has seen should be cancelled instead. Returns the result of the deletion.

    Scope
    delivery:write
    Calls
    DELETE /v1/engagements/{engagementId}/info-requests/{childId}
    Example prompt
    Delete the duplicate request I just added.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    infoRequestIdstringYesThe information request id.

    Escalate delivery engagements info requests

    Changes data

    atlas_delivery_engagements_info_requests_escalate

    Escalate an overdue information request to a higher level, with a note. Returns the updated request.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/info-requests/{childId}/escalate
    Example prompt
    Escalate the overdue data extract request to level 2.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    infoRequestIdstringYesThe information request id.
    levelintegerYesThe escalation level, from 1 to 10.
    notestringNoA note recorded with the change.

    Get delivery engagements info requests

    Read only

    atlas_delivery_engagements_info_requests_get

    Read one information request in full: what was asked, of whom, its status, due date, checklist progress, reminders and history.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/info-requests/{childId}
    Example prompt
    Show me the status of the payroll data request.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    infoRequestIdstringYesThe information request id.

    Add delivery engagements info requests items

    Changes data

    atlas_delivery_engagements_info_requests_items_add

    Add checklist items to an information request, one per label. Returns the added items.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/info-requests/{childId}/items
    Example prompt
    Add "leaver list" and "joiner list" to the HR request.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    infoRequestIdstringYesThe information request id.
    labelsarray of stringYesOne label per checklist item to add.

    List delivery engagements info requests items

    Read only

    atlas_delivery_engagements_info_requests_items_list

    List the checklist items within one information request, with whether each has been received and accepted.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/info-requests/{childId}/items
    Example prompt
    Which items in the HR request are still missing?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    infoRequestIdstringYesThe information request id.

    Update delivery engagements info requests items

    Changes data

    atlas_delivery_engagements_info_requests_items_update

    Update one checklist item within an information request: its label, whether it was received and from whom, whether it was accepted, and a note. Returns the updated item.

    Scope
    delivery:write
    Calls
    PATCH /v1/engagements/{engagementId}/info-requests/{childId}/items/{itemId}
    Example prompt
    Mark the leaver list as received from Anna.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    infoRequestIdstringYesThe information request id.
    itemIdstringYesThe checklist item id.
    labelstringNoThe item label.
    receivedbooleanNoWhether the item has been received.
    receivedByContactIdstring | nullNoThe CRM contact id of the client contact it was received from, or null to clear it.
    notestring | nullNoA note on the item, or null to clear it.

    List delivery engagements info requests

    Read only

    atlas_delivery_engagements_info_requests_list

    Read the information request list for one engagement: what has been asked of the client, what has come back, and what is overdue or blocking the plan. Use this to answer "what are we waiting on".

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/info-requests
    Example prompt
    What are we waiting on the client for?

    Arguments

    FieldTypeRequiredDescription
    idstringYesThe engagement id.

    Mark delivery engagements info requests not applicable

    Changes data

    atlas_delivery_engagements_info_requests_not_applicable_mark

    Mark an information request as not applicable to this client, with the reason. It leaves the outstanding counts. Returns the updated request.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/info-requests/{childId}/not-applicable
    Example prompt
    The client has no overseas subsidiaries, mark that request not applicable.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    infoRequestIdstringYesThe information request id.
    reasonstringYesWhy, in words a reviewer can read later.

    List delivery engagements info requests overdue

    Read only

    atlas_delivery_engagements_info_requests_overdue_list

    List information requests past their due date, optionally only those that block the plan. Use this to answer "what is the client late on".

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/info-requests/overdue
    Example prompt
    Which blocking information requests are overdue?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    limitintegerNoThe largest number of rows to return.
    blockingOnlybooleanNoWhen true, return only requests that block the plan.

    Record delivery engagements info requests partial receipt

    Changes data

    atlas_delivery_engagements_info_requests_partial_receipt_record

    Record that part of an information request has been received, with a note saying what is still missing. Returns the updated request.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/info-requests/{childId}/mark-partial
    Example prompt
    The client sent two of the three years, mark it partially received.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    infoRequestIdstringYesThe information request id.
    notestringYesWhat has been received and what is still missing.
    attachmentCountintegerNoHow many files were received.

    Remind delivery engagements info requests

    Changes data

    atlas_delivery_engagements_info_requests_remind

    Send a reminder to the person an information request is asked of. Returns the updated request with its reminder count.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/info-requests/{childId}/remind
    Example prompt
    Send a reminder for the payroll data request.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    infoRequestIdstringYesThe information request id.

    Send delivery engagements info requests

    Destructive

    atlas_delivery_engagements_info_requests_send

    Send an information request to the client, optionally with a due date and a note. It moves from not started to requested and the reminder schedule begins. Returns the updated request.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/info-requests/{childId}/request
    Example prompt
    Send the management accounts request to the client, due on the 14th.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    infoRequestIdstringYesThe information request id.
    dueAtstring (date-time)NoWhen it is due, as an ISO 8601 date-time in UTC.
    notestringNoA note sent with the request.

    Submit delivery engagements info requests

    Changes data

    atlas_delivery_engagements_info_requests_submit

    Record that the client has submitted an information request, in full or in part, with a note and who submitted it. It then waits for review. Returns the updated request.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/info-requests/{childId}/submit
    Example prompt
    Record that the finance director submitted the ledger extract.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    infoRequestIdstringYesThe information request id.
    partialbooleanNoWhether the submission is only part of what was asked.
    notestringNoA note recorded with the change.
    submittedByContactIdstringNoThe CRM contact id of the client contact who submitted it.
    attachmentCountintegerNoHow many files were submitted.

    Get delivery engagements info requests summary

    Read only

    atlas_delivery_engagements_info_requests_summary_get

    Read the information request board: counts by status, overdue and blocking counts, and completion. Use this for a quick picture before reading individual requests.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/info-requests/summary
    Example prompt
    How far along is the client with our information requests?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Apply delivery engagements info requests template

    Changes data

    atlas_delivery_engagements_info_requests_template_apply

    Add every request from an information request template to the engagement, with due dates counted from a start date. Returns the created requests.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/info-requests/from-template/{slug}
    Example prompt
    Apply the financial due diligence request template starting next Monday.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    slugstringYesThe slug of the information request template.
    startFromstring (date-time)NoThe date the template due dates count from, as an ISO 8601 date-time in UTC.
    ownerUserIdstringNoThe Atlas user id of the person who owns every created request.

    Update delivery engagements info requests

    Changes data

    atlas_delivery_engagements_info_requests_update

    Change the fields of one information request, such as its title, due date, priority, owner or blocking flag. Only the fields sent change; send null to clear a field. Returns the updated request.

    Scope
    delivery:write
    Calls
    PATCH /v1/engagements/{engagementId}/info-requests/{childId}
    Example prompt
    Push the due date on the contracts request to the end of the month.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    infoRequestIdstringYesThe information request id.
    titlestringNoA short title, in one line.
    descriptionstring | nullNoThe detail behind it, or null to clear it.
    categorystring | nullNoA free-text category used to group requests, or null to clear it.
    format"DOCUMENT" | "SPREADSHEET" | "DATA_EXTRACT" | "SYSTEM_ACCESS" | "INTERVIEW" | "WALKTHROUGH" | "CONFIRMATION" | "OTHER"NoThe form the client should provide it in.
    periodstring | nullNoThe period the information covers, or null to clear it.
    priority"LOW" | "MEDIUM" | "HIGH" | "CRITICAL"NoHow urgent it is.
    dueAtstring (date-time) | nullNoWhen it is due, as an ISO 8601 date-time in UTC, or null to clear it.
    requestedOfContactIdstring | nullNoThe CRM contact id of the client contact who is asked, or null to clear it.
    requestedOfLabelstring | nullNoA display name for the person asked, when there is no contact record, or null to clear it.
    ownerUserIdstring | nullNoThe Atlas user id of the person who owns it, or null to clear it.
    workstreamIdstring | nullNoThe id of the engagement workstream it belongs to, or null to clear it.
    blockingbooleanNoWhether the plan cannot proceed without it.
    blocksPlanItemIdstring | nullNoThe id of the plan item this request blocks, or null to clear it.

    Complete delivery engagements interviews

    Changes data

    atlas_delivery_engagements_interviews_complete

    Record that an interview took place, with key quotes, a finding summary, the interviewee sentiment and whether a follow-up is needed. Returns the updated interview.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/structuring/interviews/{childId}/complete
    Example prompt
    Record the procurement interview: supportive, main concern is supplier lock-in.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    interviewIdstringYesThe interview id.
    keyQuotesstringNoThe key quotes from the interview.
    findingSummarystringNoWhat was found.
    sentiment"CHAMPION" | "SUPPORTIVE" | "NEUTRAL" | "SCEPTICAL" | "OPPOSED"NoHow the interviewee feels about the work.
    followUpRequiredbooleanNoWhether a follow-up is needed.

    Record delivery engagements interviews consent

    Changes data

    atlas_delivery_engagements_interviews_consent_record

    Record the consent the interviewee gave: whether consent was obtained, on what basis, and whether recording and attribution are permitted. Returns the updated interview.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/structuring/interviews/{childId}/consent
    Example prompt
    Record that the interviewee consented but not to be quoted by name.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    interviewIdstringYesThe interview id.
    consentObtainedbooleanYesWhether the interviewee consented.
    consentBasisstringYesThe basis of the consent, such as WRITTEN or VERBAL.
    recordingPermittedbooleanNoWhether recording is permitted.
    attributablebooleanNoWhether what the interviewee says may be attributed to them by name.

    Create delivery engagements interviews

    Changes data

    atlas_delivery_engagements_interviews_create

    Add an interview to the engagement programme: who, their organisation and category, when, and who interviews them. Returns the created interview.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/structuring/interviews
    Example prompt
    Add an interview with the head of procurement at the client, next Tuesday.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    intervieweeNamestringYesThe name of the interviewee.
    intervieweeContactIdstringNoThe CRM contact id of the interviewee, when there is one.
    intervieweeRolestringNoThe role of the interviewee.
    organisationstringNoThe organisation the interviewee works for.
    category"CLIENT_EXEC" | "CLIENT_STAFF" | "CUSTOMER" | "SUPPLIER" | "COMPETITOR" | "EXPERT" | "REGULATOR"NoThe kind of interviewee.
    workstreamIdstringNoThe id of the engagement workstream it belongs to.
    scheduledAtstring (date-time)NoWhen it is scheduled, as an ISO 8601 date-time in UTC.
    interviewerUserIdsarray of stringNoAtlas user ids of the interviewers.
    guideAttachmentIdstringNoThe id of the attachment that holds the interview guide.
    meetingIdstringNoThe id of the governed engagement meeting.
    attributablebooleanNoWhether what the interviewee says may be attributed to them by name.
    retentionUntilstring (date-time)NoWhen the interview record may be deleted, as an ISO 8601 date-time in UTC.

    List delivery engagements interviews

    Read only

    atlas_delivery_engagements_interviews_list

    List the interviews on an engagement, optionally by status or interviewee category.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/structuring/interviews
    Example prompt
    Which customer interviews are still to be scheduled?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    status"TARGETED" | "REQUESTED" | "SCHEDULED" | "COMPLETED" | "DECLINED" | "NO_SHOW"NoFilter to one status.
    category"CLIENT_EXEC" | "CLIENT_STAFF" | "CUSTOMER" | "SUPPLIER" | "COMPETITOR" | "EXPERT" | "REGULATOR"NoFilter to one interviewee category.
    limitintegerNoThe largest number of rows to return.

    List delivery engagements legal instruments

    Read only

    atlas_delivery_engagements_legal_instruments_list

    List the legal instruments of an engagement, such as the engagement letter, statement of work, NDA and data processing agreement, with whether each is required, its status, counterparty, signatories, dates and renewal terms.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/legal-instruments
    Example prompt
    Is the engagement letter executed on Northwind?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Create delivery engagements lessons

    Changes data

    atlas_delivery_engagements_lessons_create

    Capture a lesson learned: its category, the situation, what happened, the impact, the recommendation, and how widely it applies. Returns the lesson.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/lessons
    Example prompt
    Capture a lesson: we under-estimated data cleansing effort by half.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    category"SCOPE" | "PLANNING" | "ESTIMATION" | "RESOURCING" | "CLIENT_MANAGEMENT" | "COMMUNICATION" | "TECHNICAL" | "QUALITY" | "COMMERCIAL" | "GOVERNANCE" | "THIRD_PARTY" | "TOOLING"YesThe area the lesson is about.
    titlestringYesA short title, in one line.
    situationstringNoThe situation the team was in.
    whatHappenedstringNoWhat happened.
    impactstringNoConsequence, from 1 to 5.
    recommendationstringNoWhat should be done next time.
    wouldRepeatbooleanNoWhether the team would do the same again.
    severity"MINOR" | "MODERATE" | "MAJOR"NoHow much it mattered.
    applicability"THIS_CLIENT" | "THIS_SERVICE" | "FIRM_WIDE"NoHow widely it applies: this client, this service line, or the whole firm.

    List delivery engagements lessons

    Read only

    atlas_delivery_engagements_lessons_list

    List the lessons learned on an engagement with their category, severity, applicability and whether they have been published.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/lessons
    Example prompt
    What lessons have we captured on this engagement?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    List delivery engagements

    Read only

    atlas_delivery_engagements_list

    List engagements with optional state, account, partner and free-text filters. Each row carries the reference, client, lifecycle state, health rating, dates and contract value. Use this to answer "what are we delivering" or "which engagements are red". Pass `nextCursor` back as `cursor` for the next page.

    Scope
    delivery:read
    Calls
    GET /v1/engagements
    Example prompt
    Which engagements are amber or red right now?

    Arguments

    FieldTypeRequiredDescription
    status"PIPELINE" | "ACCEPTANCE" | "MOBILISING" | "ACTIVE" | "ON_HOLD" | "IN_CLOSURE" | "HYPERCARE" | "CLOSED" | "TERMINATED_FOR_CONVENIENCE" | "TERMINATED_FOR_CAUSE" | "CANCELLED"NoFilter to one lifecycle state.
    accountIdstringNoFilter to one CRM account id.
    partnerUserIdstringNoFilter to one engagement partner.
    qstringNoFree-text search over the engagement and client name.
    limitintegerNoPage size, 1 to 200.
    cursorstringNoThe nextCursor of the previous page. Leave it out for the first page.

    Convert delivery engagements meeting agenda items

    Changes data

    atlas_delivery_engagements_meeting_agenda_items_convert

    Turn an agenda item into a task, linked back to the meeting. Returns the new task.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/meetings/{childId}/agenda/{itemId}/convert-to-task
    Example prompt
    Turn the vendor follow-up agenda item into a task for Sam.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    meetingIdstringYesThe engagement meeting id.
    agendaItemIdstringYesThe agenda item id.
    titlestringYesThe task title.
    bodystringNoThe task description.
    assigneeUserIdstringNoThe member id the new task is assigned to.
    dueAtstring (date-time)NoWhen the task is due, as an ISO 8601 UTC date-time.

    Create delivery engagements meeting agenda items

    Changes data

    atlas_delivery_engagements_meeting_agenda_items_create

    Add an item to the agenda of a governed meeting, optionally tied to a RAID item or a deliverable. Returns the new item.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/meetings/{childId}/agenda
    Example prompt
    Add the budget reforecast to the steering committee agenda for twenty minutes.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    meetingIdstringYesThe engagement meeting id.
    titlestringYesThe agenda item, in one line.
    descriptionstringNoThe detail behind it.
    purpose"DECIDE" | "DISCUSS" | "INFORM" | "APPROVE" | "REVIEW" | "ESCALATE"NoWhy the item is on the agenda.
    positionintegerNoWhere it sits in the list, from 0.
    timeboxMinintegerNoHow many minutes the item is given.
    decisionRequiredbooleanNoWhether the item needs a decision.
    raidItemIdstringNoThe RAID item the agenda item is about.
    deliverableIdstringNoThe deliverable id.

    Mark delivery engagements meeting agenda items deferred

    Changes data

    atlas_delivery_engagements_meeting_agenda_items_deferred_mark

    Defer an agenda item, so it is carried forward to the next meeting of the series. Returns the item.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/meetings/{childId}/agenda/{itemId}/defer
    Example prompt
    Defer the vendor update to the next steering committee.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    meetingIdstringYesThe engagement meeting id.
    agendaItemIdstringYesThe agenda item id.
    reasonstringNoWhy the item was deferred.

    Delete delivery engagements meeting agenda items

    Destructive

    atlas_delivery_engagements_meeting_agenda_items_delete

    Remove an item from the agenda of a governed meeting. Use defer instead when the item should move to the next meeting.

    Scope
    delivery:write
    Calls
    DELETE /v1/engagements/{engagementId}/meetings/{childId}/agenda/{itemId}
    Example prompt
    Take the vendor update off the agenda.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    meetingIdstringYesThe engagement meeting id.
    agendaItemIdstringYesThe agenda item id.

    List delivery engagements meeting agenda items

    Read only

    atlas_delivery_engagements_meeting_agenda_items_list

    Read the agenda of a governed meeting in order, with each item's purpose, timebox, status and outcome.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/meetings/{childId}/agenda
    Example prompt
    What is on the agenda for the steering committee?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    meetingIdstringYesThe engagement meeting id.

    Reorder delivery engagements meeting agenda items

    Changes data

    atlas_delivery_engagements_meeting_agenda_items_reorder

    Put the agenda of a governed meeting in a new order. Send every item id in the order wanted. Returns the agenda.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/meetings/{childId}/agenda/reorder
    Example prompt
    Put the budget item first on the steering committee agenda.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    meetingIdstringYesThe engagement meeting id.
    itemIdsarray of stringYesEvery agenda item id, in the new order.

    Update delivery engagements meeting agenda items

    Changes data

    atlas_delivery_engagements_meeting_agenda_items_update

    Change an agenda item: its title, purpose, timebox, time taken, status or outcome. Send only the fields that change. Returns the item.

    Scope
    delivery:write
    Calls
    PATCH /v1/engagements/{engagementId}/meetings/{childId}/agenda/{itemId}
    Example prompt
    Mark the budget agenda item as covered.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    meetingIdstringYesThe engagement meeting id.
    agendaItemIdstringYesThe agenda item id.
    titlestringNoThe agenda item, in one line.
    descriptionstring | nullNoThe detail behind it, or null to clear it.
    purpose"DECIDE" | "DISCUSS" | "INFORM" | "APPROVE" | "REVIEW" | "ESCALATE"NoWhy the item is on the agenda.
    timeboxMininteger | nullNoHow many minutes the item is given, or null to clear it.
    actualMininteger | nullNoHow many minutes the item actually took, or null to clear it.
    decisionRequiredbooleanNoWhether the item needs a decision.
    status"PENDING" | "COVERED" | "DEFERRED" | "DROPPED"NoWhere the item stands.
    outcomestring | nullNoWhat was concluded, or null to clear it.
    decisionMadebooleanNoWhether a decision was made on the item.

    Record delivery engagements meeting agenda outcomes

    Changes data

    atlas_delivery_engagements_meeting_agenda_outcomes_record

    Record what was concluded on an agenda item, and whether a decision was made. Returns the item.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/meetings/{childId}/agenda/{itemId}/outcome
    Example prompt
    Record that the committee agreed the revised timeline.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    meetingIdstringYesThe engagement meeting id.
    agendaItemIdstringYesThe agenda item id.
    outcomestringYesWhat was concluded.
    decisionMadebooleanNoWhether a decision was made on the item.

    Record delivery engagements meeting attendance

    Changes data

    atlas_delivery_engagements_meeting_attendance_record

    Record an attendee's response or attendance, for example accepted, attended or sent apologies. Returns the attendee.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/meetings/{childId}/attendees/{itemId}/attendance
    Example prompt
    Record that the sponsor sent apologies.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    meetingIdstringYesThe engagement meeting id.
    attendeeIdstringYesThe attendee id.
    status"INVITED" | "ACCEPTED" | "DECLINED" | "TENTATIVE" | "ATTENDED" | "APOLOGIES" | "ABSENT" | "DELEGATED" | "PARTIAL"YesThe response or attendance.
    notestringNoA note about the attendance.

    Assign delivery engagements meeting attendee delegates

    Changes data

    atlas_delivery_engagements_meeting_attendee_delegates_assign

    Record that an attendee sends someone else in their place. Returns the delegate.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/meetings/{childId}/attendees/{itemId}/delegate
    Example prompt
    The CFO is sending her deputy to the steering committee instead.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    meetingIdstringYesThe engagement meeting id.
    attendeeIdstringYesThe attendee id.
    partyType"USER" | "CLIENT_CONTACT" | "EXTERNAL"YesWho the party is: a member, a client contact, or an external party.
    partyUserIdstringNoThe member id, when the party is a member.
    partyContactIdstringNoThe CRM contact id, when the party is a client contact.
    partyLabelstringNoThe party name, when the party is external.
    partyEmailstring (email)NoThe party email address, when the party is external.
    notestringNoA note about the delegation.

    Add delivery engagements meeting attendees

    Changes data

    atlas_delivery_engagements_meeting_attendees_add

    Invite someone to a governed meeting, as a member, a client contact or an external party, with their role and whether they vote. Returns the attendee.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/meetings/{childId}/attendees
    Example prompt
    Invite the Northwind CFO to the steering committee as a voting member.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    meetingIdstringYesThe engagement meeting id.
    partyType"USER" | "CLIENT_CONTACT" | "EXTERNAL"YesWho the party is: a member, a client contact, or an external party.
    partyUserIdstringNoThe member id, when the party is a member.
    partyContactIdstringNoThe CRM contact id, when the party is a client contact.
    partyLabelstringNoThe party name, when the party is external.
    partyEmailstring (email)NoThe party email address, when the party is external.
    role"CHAIR" | "SECRETARY" | "MEMBER" | "OBSERVER" | "PRESENTER" | "GUEST"NoThe role the attendee plays in the meeting.
    votingMemberbooleanNoWhether the attendee votes.
    requiredbooleanNoWhether the attendee must attend.

    List delivery engagements meeting attendees

    Read only

    atlas_delivery_engagements_meeting_attendees_list

    List the attendees of a governed meeting with their roles, whether they vote, and their attendance.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/meetings/{childId}/attendees
    Example prompt
    Who is invited to the steering committee?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    meetingIdstringYesThe engagement meeting id.

    Remove delivery engagements meeting attendees

    Destructive

    atlas_delivery_engagements_meeting_attendees_remove

    Remove an attendee from a governed meeting, for example someone invited by mistake. Use the attendance tool to record apologies instead.

    Scope
    delivery:write
    Calls
    DELETE /v1/engagements/{engagementId}/meetings/{childId}/attendees/{itemId}
    Example prompt
    Remove the guest I invited to the steering committee by mistake.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    meetingIdstringYesThe engagement meeting id.
    attendeeIdstringYesThe attendee id.

    Update delivery engagements meeting attendees

    Changes data

    atlas_delivery_engagements_meeting_attendees_update

    Change an attendee's role, or whether they vote or are required. Returns the attendee.

    Scope
    delivery:write
    Calls
    PATCH /v1/engagements/{engagementId}/meetings/{childId}/attendees/{itemId}
    Example prompt
    Make the CFO a non-voting observer.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    meetingIdstringYesThe engagement meeting id.
    attendeeIdstringYesThe attendee id.
    role"CHAIR" | "SECRETARY" | "MEMBER" | "OBSERVER" | "PRESENTER" | "GUEST"NoThe role the attendee plays in the meeting.
    votingMemberbooleanNoWhether the attendee votes.
    requiredbooleanNoWhether the attendee must attend.

    List delivery engagements meeting carried items

    Read only

    atlas_delivery_engagements_meeting_carried_items_list

    List the agenda items and actions carried forward into this meeting from earlier meetings of the same series. Use this to answer "what is still open from last time".

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/meetings/{childId}/carried-forward
    Example prompt
    What is still open from the last steering committee?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    meetingIdstringYesThe engagement meeting id.

    Log delivery engagements meeting decisions

    Changes data

    atlas_delivery_engagements_meeting_decisions_log

    Log a decision taken under an agenda item in the decision register, linked back to the meeting. Returns the new decision.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/meetings/{childId}/agenda/{itemId}/raise-decision
    Example prompt
    Log the decision to extend testing by two weeks.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    meetingIdstringYesThe engagement meeting id.
    agendaItemIdstringYesThe agenda item id.
    titlestringYesThe decision, in one line.
    descriptionstringNoThe detail behind it.
    ownerUserIdstringNoThe member id who owns the decision.

    Compare delivery engagements meeting minutes

    Read only

    atlas_delivery_engagements_meeting_minutes_compare

    Compare the latest minutes of a governed meeting with the version before, and return what changed.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/meetings/{childId}/minutes/diff
    Example prompt
    What changed in the latest version of the minutes?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    meetingIdstringYesThe engagement meeting id.

    Draft delivery engagements meeting minutes

    Changes data

    atlas_delivery_engagements_meeting_minutes_draft

    Write the first draft of the minutes of a governed meeting, and optionally circulate them for approval straight away. Returns the minutes.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/meetings/{childId}/minutes
    Example prompt
    Draft the steering committee minutes from these notes.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    meetingIdstringYesThe engagement meeting id.
    minutesBodyanyNoThe minutes as a rich-text document.
    minutesPlainTextstringNoThe minutes as plain text.
    circulatebooleanNoTrue to circulate the minutes for approval as soon as they are saved.

    Get delivery engagements meeting minutes

    Read only

    atlas_delivery_engagements_meeting_minutes_get

    Read the minutes of a governed meeting with their approval state.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/meetings/{childId}/minutes
    Example prompt
    Show me the minutes of the last steering committee.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    meetingIdstringYesThe engagement meeting id.

    Import delivery engagements meeting minutes

    Changes data

    atlas_delivery_engagements_meeting_minutes_import

    Import the notes of the linked meeting from Granola into the minutes of a governed meeting. The workspace must have Granola connected. Returns the minutes.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/meetings/{childId}/import-granola
    Example prompt
    Pull the Granola notes into the steering committee minutes.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    meetingIdstringYesThe engagement meeting id.
    replaceExistingMinutesbooleanNoTrue to replace minutes already written. False keeps them and refuses the import.

    Update delivery engagements meeting minutes

    Changes data

    atlas_delivery_engagements_meeting_minutes_update

    Save a new version of the minutes of a governed meeting. Each save is kept as a version. Returns the minutes.

    Scope
    delivery:write
    Calls
    PUT /v1/engagements/{engagementId}/meetings/{childId}/minutes
    Example prompt
    Save this revised version of the minutes.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    meetingIdstringYesThe engagement meeting id.
    minutesBodyanyNoThe minutes as a rich-text document.
    minutesPlainTextstringNoThe minutes as plain text.

    List delivery engagements meeting minutes versions

    Read only

    atlas_delivery_engagements_meeting_minutes_versions_list

    List the saved versions of the minutes of a governed meeting, newest first.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/meetings/{childId}/minutes/versions
    Example prompt
    How many times have the steering committee minutes been revised?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    meetingIdstringYesThe engagement meeting id.

    Log delivery engagements meeting RAID items

    Changes data

    atlas_delivery_engagements_meeting_raid_items_log

    Log a risk, assumption, issue or dependency raised under an agenda item, linked back to the meeting. Returns the new RAID item.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/meetings/{childId}/agenda/{itemId}/raise-raid
    Example prompt
    Log a risk from the budget discussion: the reforecast may exceed the cap.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    meetingIdstringYesThe engagement meeting id.
    agendaItemIdstringYesThe agenda item id.
    kind"RISK" | "ASSUMPTION" | "ISSUE" | "DEPENDENCY"YesRisk, assumption, issue or dependency.
    titlestringYesThe item, in one line.
    descriptionstringNoThe detail behind it.
    ownerUserIdstringNoThe member id who owns the item.
    probabilityintegerNoLikelihood, 1 to 5.
    impactintegerNoConsequence, 1 to 5.

    Create delivery engagements meeting series

    Changes data

    atlas_delivery_engagements_meeting_series_create

    Set up a recurring governed meeting on an engagement, with its chair, secretary, quorum policy and minutes rules. Returns the new series.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/meeting-series
    Example prompt
    Set up a monthly steering committee for Northwind.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    namestringYesThe series name, for example Steering committee.
    kind"KICKOFF" | "TEAM_STANDUP" | "WORKSTREAM_REVIEW" | "STEERING_COMMITTEE" | "PROJECT_BOARD" | "SPONSOR_REVIEW" | "QBR" | "RISK_REVIEW" | "CHANGE_BOARD" | "CLIENT_CHECKIN" | "WORKSHOP" | "INTERVIEW" | "QA_REVIEW" | "RETROSPECTIVE" | "CLOSEOUT" | "AD_HOC"NoWhat kind of meeting this is.
    descriptionstringNoWhat the meeting is for.
    chairUserIdstringNoThe member id of the chair.
    secretaryUserIdstringNoThe member id of the secretary.
    defaultDurationMinintegerNoThe usual length of a meeting in the series, in minutes.
    timezonestringNoThe IANA time zone, for example Europe/London.
    quorumPolicy"NONE" | "MIN_COUNT" | "MIN_PERCENT" | "NAMED_ROLES" | "NAMED_PEOPLE"NoHow quorum is decided.
    quorumMinCountintegerNoThe minimum number of voting members for quorum.
    quorumMinPercentintegerNoThe minimum percentage of voting members for quorum.
    termsOfReferencestringNoThe terms of reference.
    requiresMinutesApprovalbooleanNoWhether the minutes must be approved.
    minutesDueHoursintegerNoHow many hours after a meeting the minutes are due.

    Delete delivery engagements meeting series

    Destructive

    atlas_delivery_engagements_meeting_series_delete

    Delete a recurring governed meeting that has no meetings. A series that has meetings is refused; set it inactive with the update tool instead, which keeps its history.

    Scope
    delivery:write
    Calls
    DELETE /v1/engagements/{engagementId}/meeting-series/{childId}
    Example prompt
    Delete the steering committee series I set up by mistake.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    seriesIdstringYesThe meeting series id.

    List delivery engagements meeting series

    Read only

    atlas_delivery_engagements_meeting_series_list

    List the recurring governed meetings of one engagement, such as a steering committee or a weekly check-in, with their chair, quorum rules and minutes rules.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/meeting-series
    Example prompt
    What recurring governance meetings does Northwind have?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Preview delivery engagements meeting series

    Changes data

    atlas_delivery_engagements_meeting_series_preview

    Preview the next occurrences of a recurring governed meeting without scheduling anything. Use this to check the dates before creating meetings from the series.

    Scope
    delivery:read
    Calls
    POST /v1/engagements/{engagementId}/meeting-series/{childId}/preview
    Example prompt
    When would the next six steering committees fall?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    seriesIdstringYesThe meeting series id.
    countintegerNoHow many occurrences to preview, at most 52: a year of weekly sittings.
    fromstring (date-time)NoPreview from this ISO 8601 UTC date-time. Defaults to now.

    Get delivery engagements meeting series terms

    Read only

    atlas_delivery_engagements_meeting_series_terms_get

    Read the terms of reference of a recurring governed meeting: its purpose, membership and decision rights.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/meeting-series/{childId}/terms-of-reference
    Example prompt
    What are the terms of reference of the Northwind steering committee?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    seriesIdstringYesThe meeting series id.

    Set delivery engagements meeting series terms

    Changes data

    atlas_delivery_engagements_meeting_series_terms_set

    Replace the terms of reference of a recurring governed meeting. Returns the saved terms.

    Scope
    delivery:write
    Calls
    PUT /v1/engagements/{engagementId}/meeting-series/{childId}/terms-of-reference
    Example prompt
    Update the steering committee terms of reference with this text.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    seriesIdstringYesThe meeting series id.
    termsOfReferencestring | nullYesThe terms of reference, or null to clear them.

    Update delivery engagements meeting series

    Changes data

    atlas_delivery_engagements_meeting_series_update

    Change a recurring governed meeting: its name, people, quorum policy, minutes rules or whether it is still active. Send only the fields that change. Returns the updated series.

    Scope
    delivery:write
    Calls
    PATCH /v1/engagements/{engagementId}/meeting-series/{childId}
    Example prompt
    Make Priya the chair of the Northwind steering committee.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    seriesIdstringYesThe meeting series id.
    namestringNoThe series name.
    kind"KICKOFF" | "TEAM_STANDUP" | "WORKSTREAM_REVIEW" | "STEERING_COMMITTEE" | "PROJECT_BOARD" | "SPONSOR_REVIEW" | "QBR" | "RISK_REVIEW" | "CHANGE_BOARD" | "CLIENT_CHECKIN" | "WORKSHOP" | "INTERVIEW" | "QA_REVIEW" | "RETROSPECTIVE" | "CLOSEOUT" | "AD_HOC"NoWhat kind of meeting this is.
    descriptionstring | nullNoWhat the meeting is for, or null to clear it.
    chairUserIdstring | nullNoThe member id of the chair, or null to clear it.
    secretaryUserIdstring | nullNoThe member id of the secretary, or null to clear it.
    ownerUserIdstring | nullNoThe member id of the owner, or null to clear it.
    defaultDurationMinintegerNoThe usual length of a meeting in the series, in minutes.
    defaultLocationstring | nullNoThe usual location of a meeting in the series, or null to clear it.
    timezonestringNoThe IANA time zone, for example Europe/London.
    quorumPolicy"NONE" | "MIN_COUNT" | "MIN_PERCENT" | "NAMED_ROLES" | "NAMED_PEOPLE"NoHow quorum is decided.
    quorumMinCountinteger | nullNoThe minimum number of voting members for quorum, or null to clear it.
    quorumMinPercentinteger | nullNoThe minimum percentage of voting members for quorum, or null to clear it.
    minutesApproverUserIdstring | nullNoThe member id who approves the minutes, or null to clear it.
    minutesApproverContactIdstring | nullNoThe client contact id who approves the minutes, or null to clear it.
    requiresMinutesApprovalbooleanNoWhether the minutes must be approved.
    minutesDueHoursintegerNoHow many hours after a meeting the minutes are due.
    activebooleanNoWhether the series still schedules meetings.

    List delivery engagements meeting votes

    Read only

    atlas_delivery_engagements_meeting_votes_list

    List the votes cast in a governed meeting, by motion, with who voted and how. Use this to answer "was the motion carried".

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/meetings/{childId}/votes
    Example prompt
    Was the motion to extend testing carried?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    meetingIdstringYesThe engagement meeting id.

    Record delivery engagements meeting votes

    Changes data

    atlas_delivery_engagements_meeting_votes_record

    Record a vote cast by a voting attendee on a motion. Returns the vote.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/meetings/{childId}/votes
    Example prompt
    Record the CFO vote in favour of extending testing.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    meetingIdstringYesThe engagement meeting id.
    motionstringYesThe motion being voted on.
    attendeeIdstringYesThe attendee casting the vote.
    vote"FOR" | "AGAINST" | "ABSTAIN" | "VETO"YesThe vote.
    rationalestringNoThe reason for the vote.
    agendaItemIdstringNoThe agenda item the vote is about.

    Get delivery engagements meetings calendar

    Read only

    atlas_delivery_engagements_meetings_calendar_get

    Read the governed meetings of one engagement between two dates, for a calendar view. Use this to answer "what meetings are there next week".

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/meetings/calendar
    Example prompt
    What Northwind meetings are there next week?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    fromstring (date-time)YesThe start of the window, as an ISO 8601 UTC date-time.
    tostring (date-time)YesThe end of the window, as an ISO 8601 UTC date-time.
    seriesIdstringNoFilter to one meeting series.

    Cancel delivery engagements meetings

    Destructive

    atlas_delivery_engagements_meetings_cancel

    Cancel a governed meeting. The record stays, marked cancelled, with the reason.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/meetings/{childId}/cancel
    Example prompt
    Cancel Thursday's risk review because the sponsor is away.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    meetingIdstringYesThe engagement meeting id.
    reasonstringNoWhy the meeting was cancelled.

    Create delivery engagements meetings

    Changes data

    atlas_delivery_engagements_meetings_create

    Schedule a governed meeting on an engagement, on its own or as part of a series. Returns the new meeting.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/meetings
    Example prompt
    Schedule a risk review for Northwind on Thursday at ten.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    meetingTitlestringYesThe meeting title.
    seriesIdstringNoThe meeting series the meeting belongs to.
    meetingIdstringNoThe id of a platform meeting to link.
    scheduledAtstring (date-time)NoWhen the meeting is scheduled, as an ISO 8601 UTC date-time.
    kind"KICKOFF" | "TEAM_STANDUP" | "WORKSTREAM_REVIEW" | "STEERING_COMMITTEE" | "PROJECT_BOARD" | "SPONSOR_REVIEW" | "QBR" | "RISK_REVIEW" | "CHANGE_BOARD" | "CLIENT_CHECKIN" | "WORKSHOP" | "INTERVIEW" | "QA_REVIEW" | "RETROSPECTIVE" | "CLOSEOUT" | "AD_HOC"NoWhat kind of meeting this is.
    occurrenceKeystringNoA key that identifies this occurrence in the series, so it is not scheduled twice.
    chairUserIdstringNoThe member id of the chair.
    secretaryUserIdstringNoThe member id of the secretary.
    purposestringNoWhat the meeting is for.
    locationstringNoWhere the meeting takes place.
    quorumPolicy"NONE" | "MIN_COUNT" | "MIN_PERCENT" | "NAMED_ROLES" | "NAMED_PEOPLE"NoHow quorum is decided.
    quorumRequiredCountintegerNoThe number of voting members needed for quorum.

    Delete delivery engagements meetings

    Destructive

    atlas_delivery_engagements_meetings_delete

    Take a governed meeting off the register. It is refused once the minutes have been circulated; cancel the meeting instead, which keeps the record and says it did not go ahead.

    Scope
    delivery:write
    Calls
    DELETE /v1/engagements/{engagementId}/meetings/{childId}
    Example prompt
    Delete the duplicate risk review I scheduled.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    meetingIdstringYesThe engagement meeting id.

    Get delivery engagements meetings

    Read only

    atlas_delivery_engagements_meetings_get

    Read one governed meeting: its date, chair, attendees, quorum and the state of its minutes. Quorum has three states: met, not met, and not evaluated.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/meetings/{childId}
    Example prompt
    Show me the details of the last Northwind steering committee.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    meetingIdstringYesThe engagement meeting id.

    Mark delivery engagements meetings held

    Changes data

    atlas_delivery_engagements_meetings_held_mark

    Record that a governed meeting took place, with when and for how long. Whether it is recorded as held or as held without quorum follows from the quorum already recorded, not from the caller. Returns the meeting.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/meetings/{childId}/hold
    Example prompt
    Record that the steering committee took place this morning for ninety minutes.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    meetingIdstringYesThe engagement meeting id.
    heldAtstring (date-time)NoWhen the meeting was held, as an ISO 8601 UTC date-time. Defaults to now.
    durationMinintegerNoThe length in minutes.

    Link delivery engagements meetings

    Changes data

    atlas_delivery_engagements_meetings_link

    Link a governed meeting to an Atlas meeting, so its notes and recording sit with the governed record. Returns the linked meeting.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/meetings/{childId}/bind-meeting
    Example prompt
    Link the steering committee to the Atlas meeting we recorded.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    meetingIdstringYesThe engagement meeting id.
    platformMeetingIdstringYesThe id of the Atlas meeting to link.

    List delivery engagements meetings

    Read only

    atlas_delivery_engagements_meetings_list

    Read the governed meetings of one engagement, with quorum and the state of their minutes. Quorum has three states and they differ: not evaluated is not the same as not met.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/meetings
    Example prompt
    Which minutes are still unapproved?

    Arguments

    FieldTypeRequiredDescription
    idstringYesThe engagement id.

    Start delivery engagements meetings

    Changes data

    atlas_delivery_engagements_meetings_start

    Mark a governed meeting as in progress. Returns the meeting.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/meetings/{childId}/start
    Example prompt
    Mark the steering committee as started.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    meetingIdstringYesThe engagement meeting id.

    Unlink delivery engagements meetings

    Changes data

    atlas_delivery_engagements_meetings_unlink

    Remove the link between a governed meeting and an Atlas meeting. Neither meeting is deleted.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/meetings/{childId}/unbind-meeting
    Example prompt
    Unlink the steering committee from the wrong Atlas meeting.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    meetingIdstringYesThe engagement meeting id.

    Update delivery engagements meetings

    Changes data

    atlas_delivery_engagements_meetings_update

    Change a governed meeting: its title, time, length, people, location or quorum. Send only the fields that change. Returns the updated meeting.

    Scope
    delivery:write
    Calls
    PATCH /v1/engagements/{engagementId}/meetings/{childId}
    Example prompt
    Move the Northwind risk review to Friday afternoon.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    meetingIdstringYesThe engagement meeting id.
    meetingTitlestringNoThe meeting title.
    scheduledAtstring (date-time) | nullNoWhen the meeting is scheduled, as an ISO 8601 UTC date-time, or null to clear it.
    heldAtstring (date-time) | nullNoWhen the meeting was held, as an ISO 8601 UTC date-time, or null to clear it.
    durationMininteger | nullNoThe length in minutes, or null to clear it.
    kind"KICKOFF" | "TEAM_STANDUP" | "WORKSTREAM_REVIEW" | "STEERING_COMMITTEE" | "PROJECT_BOARD" | "SPONSOR_REVIEW" | "QBR" | "RISK_REVIEW" | "CHANGE_BOARD" | "CLIENT_CHECKIN" | "WORKSHOP" | "INTERVIEW" | "QA_REVIEW" | "RETROSPECTIVE" | "CLOSEOUT" | "AD_HOC"NoWhat kind of meeting this is.
    chairUserIdstring | nullNoThe member id of the chair, or null to clear it.
    secretaryUserIdstring | nullNoThe member id of the secretary, or null to clear it.
    purposestring | nullNoWhat the meeting is for, or null to clear it.
    locationstring | nullNoWhere the meeting takes place, or null to clear it.
    quorumPolicy"NONE" | "MIN_COUNT" | "MIN_PERCENT" | "NAMED_ROLES" | "NAMED_PEOPLE"NoHow quorum is decided.
    quorumRequiredCountinteger | nullNoThe number of voting members needed for quorum, or null to clear it.

    Get delivery engagements metrics

    Read only

    atlas_delivery_engagements_metrics_get

    Read the metric catalogue of one engagement over a period: lock-up, the health score, governance, quality, delivery, people and commercial measures, the operating model metrics, and a list of what could not be measured. Use this for a full scorecard of one engagement rather than one figure.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/metrics
    Example prompt
    Give me the full scorecard for Northwind over the last 90 days.

    Arguments

    FieldTypeRequiredDescription
    idstringYesThe engagement id.
    daysInPeriodintegerNoThe length of the measured period in whole days, 7 to 730. The route default applies when left out.

    Capture delivery engagements milestone trend

    Changes data

    atlas_delivery_engagements_milestone_trend_capture

    Capture today's forecast date of every milestone as a point on the milestone trend. Returns the capture.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/plan/milestone-trend/capture
    Example prompt
    Capture this week's milestone forecast.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Get delivery engagements milestone trend

    Read only

    atlas_delivery_engagements_milestone_trend_get

    Read the milestone trend: how the forecast date of each milestone has moved at each capture. Use this to answer "are the milestones slipping".

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/plan/milestone-trend
    Example prompt
    Are the Northwind milestones slipping?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    sincestringNoThe earliest date to include, YYYY-MM-DD.

    Archive delivery engagements models

    Changes data

    atlas_delivery_engagements_models_archive

    Retire a model so it is no longer used, with the reason and the model that replaces it. Returns the updated model.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/models/{modelId}/retire
    Example prompt
    Retire version 1 of the pricing model, replaced by version 2.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    modelIdstringYesThe model id.
    reasonstringNoWhy the model is retired.
    replacedByIdstringNoThe id of the model that replaces this one.

    Create delivery engagements models

    Changes data

    atlas_delivery_engagements_models_create

    Register a model built on the engagement: its type, purpose, tier, owners, inputs, assumptions, controls, limitations and, for a model based on a large language model, its provider and controls. Returns the registered model.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/models
    Example prompt
    Register the pricing elasticity model as a tier 2 statistical model owned by Sam.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    namestringYesThe model name.
    modelType"DETERMINISTIC_FINANCIAL" | "STATISTICAL" | "ML" | "OPTIMISATION" | "SIMULATION" | "RULES_ENGINE" | "LLM_BASED"YesWhat kind of model it is.
    purposestringNoWhat it is for.
    businessDecisionSupportedstringNoThe business decision the model supports.
    tierintegerNoThe model risk tier, from 1 (highest) to 3.
    tieringRationalestringNoWhy the model sits in its tier.
    developerIdstringNoThe Atlas user id of the model developer.
    ownerIdstringNoThe Atlas user id of the model owner.
    independentValidatorIdstringNoThe Atlas user id of the independent validator.
    inputsobjectNoThe model inputs, keyed by name.
    assumptionIdsarray of stringNoThe ids of the analytical assumptions the model uses.
    methodologyDocumentIdstringNoThe id of the document that describes the methodology.
    versionstringNoThe version label.
    codeRepostringNoWhere the model code is held.
    commitHashstringNoThe commit the approved version was built from.
    controlsarray of stringNoThe controls applied to the model.
    spreadsheetAuditToolRunstringNoThe spreadsheet audit tool run reference, for a spreadsheet model.
    sensitivityDonebooleanNoWhether sensitivity testing has been done.
    knownLimitationsstringNoThe known limitations of the model.
    useRestrictionsstringNoRestrictions on how the model may be used.
    outOfScopeUsesstringNoUses the model must not be put to.
    monitoringPlanstringNoHow the model is monitored in use.
    recalibrationFrequencystringNoHow often the model is recalibrated.
    modelProviderstringNoThe provider of the underlying model, for a model based on a large language model.
    modelVersionstringNoThe version of the underlying model.
    promptIdstringNoThe id of the prompt the model uses, for a model based on a large language model.
    temperaturenumberNoThe sampling temperature, from 0 to 2, for a model based on a large language model.
    trainingDataDisclosurestringNoWhat is disclosed about the training data.
    hallucinationControlsstringNoThe controls against fabricated output, for a model based on a large language model.
    humanReviewRequiredbooleanNoWhether a person must review each output.
    outputLoggedbooleanNoWhether each output is logged.

    Get delivery engagements models

    Read only

    atlas_delivery_engagements_models_get

    Read one registered model in full, including its validation findings and approved purposes.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/models/{modelId}
    Example prompt
    Show me the pricing model entry.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    modelIdstringYesThe model id.

    List delivery engagements models

    Read only

    atlas_delivery_engagements_models_list

    List the models registered on an engagement with their type, tier, validation status and owner.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/models
    Example prompt
    Which models are on this engagement?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    includeRetiredbooleanNoWhen true, include retired models.
    tierintegerNoOnly models of this risk tier, from 1 (highest) to 3.
    limitintegerNoThe largest number of rows to return.

    List delivery engagements models unvalidated

    Read only

    atlas_delivery_engagements_models_unvalidated_list

    List the models that have not passed independent validation. Use this to answer "which models are in use without validation".

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/models/unvalidated
    Example prompt
    Which models have not been validated yet?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Update delivery engagements models

    Changes data

    atlas_delivery_engagements_models_update

    Change the fields of a registered model. Only the fields sent change; send null to clear a person field. Returns the updated model.

    Scope
    delivery:write
    Calls
    PATCH /v1/engagements/{engagementId}/models/{modelId}
    Example prompt
    Record that sensitivity testing has been done on the pricing model.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    modelIdstringYesThe model id.
    namestringNoThe model name.
    modelType"DETERMINISTIC_FINANCIAL" | "STATISTICAL" | "ML" | "OPTIMISATION" | "SIMULATION" | "RULES_ENGINE" | "LLM_BASED"NoWhat kind of model it is.
    purposestringNoWhat it is for.
    businessDecisionSupportedstringNoThe business decision the model supports.
    tierintegerNoThe model risk tier, from 1 (highest) to 3.
    tieringRationalestringNoWhy the model sits in its tier.
    developerIdstring | nullNoThe Atlas user id of the model developer, or null to clear it.
    ownerIdstring | nullNoThe Atlas user id of the model owner, or null to clear it.
    independentValidatorIdstring | nullNoThe Atlas user id of the independent validator, or null to clear it.
    inputsobjectNoThe model inputs, keyed by name.
    assumptionIdsarray of stringNoThe ids of the analytical assumptions the model uses.
    methodologyDocumentIdstringNoThe id of the document that describes the methodology.
    versionstringNoThe version label.
    codeRepostringNoWhere the model code is held.
    commitHashstringNoThe commit the approved version was built from.
    controlsarray of stringNoThe controls applied to the model.
    spreadsheetAuditToolRunstringNoThe spreadsheet audit tool run reference, for a spreadsheet model.
    sensitivityDonebooleanNoWhether sensitivity testing has been done.
    knownLimitationsstringNoThe known limitations of the model.
    useRestrictionsstringNoRestrictions on how the model may be used.
    outOfScopeUsesstringNoUses the model must not be put to.
    monitoringPlanstringNoHow the model is monitored in use.
    recalibrationFrequencystringNoHow often the model is recalibrated.
    modelProviderstringNoThe provider of the underlying model, for a model based on a large language model.
    modelVersionstringNoThe version of the underlying model.
    promptIdstringNoThe id of the prompt the model uses, for a model based on a large language model.
    temperaturenumberNoThe sampling temperature, from 0 to 2, for a model based on a large language model.
    trainingDataDisclosurestringNoWhat is disclosed about the training data.
    hallucinationControlsstringNoThe controls against fabricated output, for a model based on a large language model.
    humanReviewRequiredbooleanNoWhether a person must review each output.
    outputLoggedbooleanNoWhether each output is logged.

    List delivery engagements non audit services

    Read only

    atlas_delivery_engagements_non_audit_services_list

    List the non-audit services provided to an audit client on an engagement, with their fees, period and the gaps in each entry, such as a missing pre-approval reference or permissibility rationale.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/non-audit-services
    Example prompt
    Which non-audit services have we provided to Acme this year?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Record delivery engagements non audit services

    Changes data

    atlas_delivery_engagements_non_audit_services_record

    Record a non-audit service provided to an audit client, with its fee and period. The permissibility rationale and the pre-approval reference are left for the partner to record in Atlas, so the entry shows those gaps until they do. Returns the entry with its warnings.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/non-audit-services
    Example prompt
    Record the tax compliance service we provide to Acme for FY2026, fee 18,000 GBP.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    serviceDescriptionstringYesWhat the service is.
    feeAmountnumberNoThe fee for the service.
    currencystringNoThe three-letter currency code of the fee.
    periodCoveredstringNoThe period the service covers, such as FY2026.

    Create delivery engagements objectives

    Changes data

    atlas_delivery_engagements_objectives_create

    Add an objective to an engagement with the measure of its success. Returns the new objective.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/objectives
    Example prompt
    Add an objective to cut order processing time by thirty percent.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    statementstringYesThe objective, in one sentence.
    successMeasurestringYesHow success is measured.
    positionintegerNoWhere it sits in the list, from 0.
    baselineValuestringNoWhere the measure stands today.
    targetValuestringNoWhere the measure should end up.
    unitstringNoThe unit the measure is expressed in.
    ownerUserIdstringNoThe member id who owns the objective.
    workstreamIdstringNoThe workstream id.

    List delivery engagements objectives

    Read only

    atlas_delivery_engagements_objectives_list

    List the objectives of one engagement with their success measures, baselines and targets. Use this to answer "what is this engagement meant to achieve".

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/objectives
    Example prompt
    What is the Northwind engagement meant to achieve?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Create delivery engagements obligations

    Changes data

    atlas_delivery_engagements_obligations_create

    Record one obligation from a contract on an engagement: the instrument and clause, what it requires, its type and due pattern, the owner role, the next due date, the evidence it needs and the consequence of breach. Returns the obligation.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/obligations
    Example prompt
    Record clause 7.2 of the MSA: a monthly SLA report is due on the fifth.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    instrumentIdstringYesThe id of the legal instrument the clause is in.
    clauseRefstringYesThe clause reference, such as 7.2.
    obligationTextstringYesWhat the clause obliges the team to do.
    obligationType"DELIVERABLE" | "SLA" | "REPORTING" | "INSURANCE" | "AUDIT" | "NOTIFICATION" | "DATA" | "PERSONNEL" | "SECURITY" | "COMPLIANCE" | "PAYMENT" | "IP" | "CONFIDENTIALITY"YesThe kind of obligation.
    duePattern"ONE_OFF" | "RECURRING" | "EVENT_DRIVEN"YesWhether it falls due once, recurs, or is driven by an event.
    ownerRolestringNoThe role that owns it.
    nextDueAtstringNoWhen it next falls due, as an ISO 8601 date-time.
    evidenceRequiredstringNoThe evidence needed to show it was met.
    breachConsequencestringNoWhat follows if it is breached.
    linkedTaskIdstringNoThe id of a task that tracks the work.
    linkedFollowUpIdstringNoThe id of a follow-up that tracks the work.

    List delivery engagements obligations due

    Read only

    atlas_delivery_engagements_obligations_due_list

    List the contract obligations of an engagement that fall due within a number of days, together with every one already overdue. Use this to answer "which contract commitments are due".

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/obligations/due
    Example prompt
    Which contract obligations fall due this month?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    daysintegerNoThe window ahead, in days. The default is 30.

    List delivery engagements obligations

    Read only

    atlas_delivery_engagements_obligations_list

    List the contract obligation register of an engagement: each clause the team must perform, its type, due pattern, next due date, owner, evidence requirement, breach consequence and status.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/obligations
    Example prompt
    Show the contract obligations register for Northwind.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Get delivery engagements operating model

    Read only

    atlas_delivery_engagements_operating_model_get

    Describe the operating model of an engagement: the governance forums, the cadence, the roles and the controls that apply to it, as configured.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/operating-model
    Example prompt
    How is this engagement governed?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    List delivery engagements pe watches

    Read only

    atlas_delivery_engagements_pe_watches_list

    List the permanent establishment watches on an engagement: each jurisdiction, the day threshold, the alert point, the days counted from time recorded so far, and the risks and mitigations noted.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/pe-watches
    Example prompt
    How many days has the team spent in Germany on Northwind against the permanent establishment threshold?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Set delivery engagements pe watches

    Changes data

    atlas_delivery_engagements_pe_watches_set

    Save the permanent establishment watch for one jurisdiction on an engagement: the day threshold, the day at which to alert, which must come before it, and the risks and mitigations. An existing watch for the jurisdiction is replaced. Returns the watch.

    Scope
    delivery:write
    Calls
    PUT /v1/engagements/{engagementId}/pe-watches
    Example prompt
    Watch Germany for permanent establishment: threshold 183 days, alert at 150.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    jurisdictionstringYesThe two-letter country code of the jurisdiction.
    thresholdDaysintegerYesThe day count at which a permanent establishment arises.
    alertAtDaysintegerYesThe day count at which to alert, which must be below the threshold.
    fixedPlaceOfBusinessRiskbooleanNoWhether there is a fixed place of business risk.
    dependentAgentRiskbooleanNoWhether there is a dependent agent risk.
    mitigationsstringNoThe mitigations in place.

    Create delivery engagements phases

    Changes data

    atlas_delivery_engagements_phases_create

    Add a phase to an engagement, optionally ending at a gate that must be passed before the next phase starts. Returns the new phase.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/phases
    Example prompt
    Add a design phase to the Northwind engagement ending at a gate.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    keystringYesA short key, unique within the engagement.
    namestringYesThe phase name.
    kind"ACCEPTANCE" | "MOBILISE" | "DIAGNOSTIC" | "DESIGN" | "BUILD" | "TEST" | "DEPLOY" | "STABILISE" | "HYPERCARE" | "CLOSE" | "CUSTOM"NoWhat kind of phase this is.
    descriptionstringNoWhat the phase covers.
    positionintegerNoWhere it sits in the list, from 0.
    gateRequiredbooleanNoWhether the phase ends at a gate that must be passed.
    gateCriteriastringNoWhat must be true to pass the gate at the end of the phase.
    plannedStartsOnstring (date-time)NoThe planned start of the phase, as an ISO 8601 UTC date-time.
    plannedEndsOnstring (date-time)NoThe planned end of the phase, as an ISO 8601 UTC date-time.

    List delivery engagements phases

    Read only

    atlas_delivery_engagements_phases_list

    List the phases of one engagement in order, with their planned dates and gate state. Use this to answer "which phase are we in".

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/phases
    Example prompt
    Which phase is the Northwind engagement in?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Create delivery engagements plan dependencies

    Changes data

    atlas_delivery_engagements_plan_dependencies_create

    Add a dependency between two plan items. The API refuses a dependency its scheduling rules do not allow and says why. Returns the new dependency.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/plan/dependencies
    Example prompt
    Make testing start only after the data load finishes.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    fromPlanItemIdstringYesThe plan item the dependency starts from.
    toPlanItemIdstringYesThe plan item the dependency points to.
    type"FS" | "SS" | "FF" | "SF"NoThe dependency type: finish to start (FS), start to start (SS), finish to finish (FF) or start to finish (SF).
    lagDaysintegerNoThe lag in days. Negative for a lead.
    hardbooleanNoWhether the dependency is a hard constraint.
    notestringNoA note to record with it.

    Delete delivery engagements plan dependencies

    Destructive

    atlas_delivery_engagements_plan_dependencies_delete

    Remove a dependency between two plan items. Recompute the critical path afterwards to see the effect.

    Scope
    delivery:write
    Calls
    DELETE /v1/engagements/{engagementId}/plan/dependencies/{childId}
    Example prompt
    Remove the dependency between training and go-live.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    dependencyIdstringYesThe dependency id.

    List delivery engagements plan dependencies

    Read only

    atlas_delivery_engagements_plan_dependencies_list

    List the dependencies between plan items of one engagement, with their type and lag.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/plan/dependencies
    Example prompt
    What depends on the data load task?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Update delivery engagements plan dependencies

    Changes data

    atlas_delivery_engagements_plan_dependencies_update

    Change the type, lag or hardness of a dependency. Returns the dependency.

    Scope
    delivery:write
    Calls
    PATCH /v1/engagements/{engagementId}/plan/dependencies/{childId}
    Example prompt
    Add a two-day lag to the testing dependency.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    dependencyIdstringYesThe dependency id.
    type"FS" | "SS" | "FF" | "SF"NoThe dependency type: finish to start (FS), start to start (SS), finish to finish (FF) or start to finish (SF).
    lagDaysintegerNoThe lag in days. Negative for a lead.
    hardbooleanNoWhether the dependency is a hard constraint.
    notestring | nullNoA note about the dependency, or null to clear it.

    Validate delivery engagements plan dependencies

    Changes data

    atlas_delivery_engagements_plan_dependencies_validate

    Check whether a dependency could be added, without adding it. Returns the refusal the create would give, or nothing when it would succeed.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/plan/dependencies/validate
    Example prompt
    Could I make go-live depend on training without breaking the plan?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    fromPlanItemIdstringYesThe plan item the dependency starts from.
    toPlanItemIdstringYesThe plan item the dependency points to.
    type"FS" | "SS" | "FF" | "SF"NoThe dependency type: finish to start (FS), start to start (SS), finish to finish (FF) or start to finish (SF).
    lagDaysintegerNoThe lag in days. Negative for a lead.
    hardbooleanNoWhether the dependency is a hard constraint.
    notestringNoA note to record with it.

    Export delivery engagements plan

    Read only

    atlas_delivery_engagements_plan_export

    Export the plan of an engagement with every item, dependency and date, in a form another scheduling tool can import.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/plan/export
    Example prompt
    Export the Northwind plan so I can open it in another scheduling tool.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    List delivery engagements plan float

    Read only

    atlas_delivery_engagements_plan_float_list

    List plan items by how much float they have, least first. Use this to answer "what is about to become critical".

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/plan/float
    Example prompt
    Which tasks are about to become critical?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    maxFloatDaysintegerNoOnly items with at most this much float, in days.
    limitintegerNoPage size.

    Get delivery engagements plan gantt

    Read only

    atlas_delivery_engagements_plan_gantt_get

    Read the plan, its dependencies and its variance against the baseline in one response, as a Gantt chart needs them.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/plan/gantt
    Example prompt
    Show me the Northwind plan as a Gantt chart.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Get delivery engagements plan

    Read only

    atlas_delivery_engagements_plan_get

    Read the plan for one engagement: every row of the work breakdown structure with its dates, percent complete, critical-path flag and float. Use this to answer "what is on the critical path" or "what slipped".

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/plan
    Example prompt
    What is on the critical path for Northwind?

    Arguments

    FieldTypeRequiredDescription
    idstringYesThe engagement id.

    Convert delivery engagements plan items

    Changes data

    atlas_delivery_engagements_plan_items_convert

    Create a task from a plan item and link the two, so progress on the task shows in the plan. Returns the new task.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/plan/items/{childId}/convert-to-task
    Example prompt
    Turn the data load plan item into a task.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    planItemIdstringYesThe plan item id.
    titlestringNoThe task title. Defaults to the plan item title.

    Create delivery engagements plan items

    Changes data

    atlas_delivery_engagements_plan_items_create

    Add a row to the plan of an engagement: a task, a milestone, a summary or a gate, with its dates, effort and constraints. Returns the new plan item.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/plan
    Example prompt
    Add a user acceptance testing task to the Northwind plan for three weeks.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    titlestringYesThe plan item, in one line.
    kind"TASK" | "MILESTONE" | "SUMMARY" | "GATE"NoWhat kind of plan item this is.
    taskIdstringNoThe task id to link.
    milestoneIdstringNoThe project milestone id to link.
    parentPlanItemIdstringNoThe parent plan item id.
    positionintegerNoWhere it sits in the list, from 0.
    workstreamIdstringNoThe workstream id.
    plannedStartsAtstring (date-time)NoThe planned start, as an ISO 8601 UTC date-time.
    plannedEndsAtstring (date-time)NoThe planned finish, as an ISO 8601 UTC date-time.
    durationDaysintegerNoThe duration in working days.
    effortEstimateMinintegerNoThe estimated effort in minutes.
    constraintType"ASAP" | "ALAP" | "SNET" | "SNLT" | "FNET" | "FNLT" | "MSO" | "MFO"NoThe scheduling constraint, for example ASAP or must start on (MSO).
    constraintDatestring (date-time)NoThe date the scheduling constraint refers to, as an ISO 8601 UTC date-time.
    deadlineDatestring (date-time)NoThe date the work must finish by, as an ISO 8601 UTC date-time.
    ownerUserIdstringNoThe member id who owns the item.

    Delete delivery engagements plan items

    Destructive

    atlas_delivery_engagements_plan_items_delete

    Delete a plan item and the dependencies that touch it. Returns how many dependencies were removed. Use this only when the person asks to delete it.

    Scope
    delivery:write
    Calls
    DELETE /v1/engagements/{engagementId}/plan/items/{childId}
    Example prompt
    Delete the duplicate testing task from the plan.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    planItemIdstringYesThe plan item id.

    Import delivery engagements plan items

    Changes data

    atlas_delivery_engagements_plan_items_import

    Bring existing tasks into the plan of an engagement as plan items linked to them. Returns the new plan items.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/plan/from-tasks
    Example prompt
    Bring these three project tasks into the Northwind plan.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    taskIdsarray of stringYesThe task ids to bring into the plan.
    parentPlanItemIdstringNoThe plan item to put them under.
    workstreamIdstringNoThe workstream id.
    phaseIdstringNoThe phase to put them in.

    Move delivery engagements plan items

    Changes data

    atlas_delivery_engagements_plan_items_move

    Shift the dates of several plan items by the same number of days. Returns the moved items.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/plan/bulk-shift
    Example prompt
    Push every testing task back five days.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    planItemIdsarray of stringYesThe plan item ids to move.
    shiftDaysintegerYesHow many days to move the items. Negative to bring them forward.

    Reorder delivery engagements plan items

    Changes data

    atlas_delivery_engagements_plan_items_reorder

    Move plan items to new positions or under new parents in one request. Returns the plan.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/plan/items/reorder
    Example prompt
    Move the testing tasks under the build phase.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    itemsarray of objectYesThe items to move, each with its new position and parent.

    Update delivery engagements plan items

    Changes data

    atlas_delivery_engagements_plan_items_update

    Change a plan item: its title, dates, progress, effort, parent or constraints. Send only the fields that change. Returns the item.

    Scope
    delivery:write
    Calls
    PATCH /v1/engagements/{engagementId}/plan/items/{childId}
    Example prompt
    Mark the data load task as sixty percent complete.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    planItemIdstringYesThe plan item id.
    titlestringNoThe plan item, in one line.
    kind"TASK" | "MILESTONE" | "SUMMARY" | "GATE"NoWhat kind of plan item this is.
    parentPlanItemIdstring | nullNoThe parent plan item id, or null for the top level.
    positionintegerNoWhere it sits in the list, from 0.
    workstreamIdstring | nullNoThe workstream id, or null to clear it.
    phaseIdstring | nullNoThe phase id, or null to clear it.
    plannedStartsAtstring (date-time) | nullNoThe planned start, as an ISO 8601 UTC date-time, or null to clear it.
    plannedEndsAtstring (date-time) | nullNoThe planned finish, as an ISO 8601 UTC date-time, or null to clear it.
    actualStartsAtstring (date-time) | nullNoWhen the work actually started, as an ISO 8601 UTC date-time, or null to clear it.
    actualEndsAtstring (date-time) | nullNoWhen the work actually finished, as an ISO 8601 UTC date-time, or null to clear it.
    durationDaysinteger | nullNoThe duration in working days, or null to clear it.
    effortEstimateMininteger | nullNoThe estimated effort in minutes, or null to clear it.
    percentCompleteintegerNoHow complete it is, 0 to 100.
    isMilestoneGatebooleanNoWhether the item is a gate milestone.
    constraintType"ASAP" | "ALAP" | "SNET" | "SNLT" | "FNET" | "FNLT" | "MSO" | "MFO"NoThe scheduling constraint, for example ASAP or must start on (MSO).
    constraintDatestring (date-time) | nullNoThe date the scheduling constraint refers to, as an ISO 8601 UTC date-time, or null to clear it.
    deadlineDatestring (date-time) | nullNoThe date the work must finish by, as an ISO 8601 UTC date-time, or null to clear it.
    ownerUserIdstring | nullNoThe member id who owns the item, or null to clear it.

    Run delivery engagements plan leveling

    Changes data

    atlas_delivery_engagements_plan_leveling_run

    Level the plan so no person is booked beyond capacity. By default it returns the proposed moves and changes nothing; send apply with the fingerprint the proposal reported to write them.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/plan/level
    Example prompt
    Is anyone overbooked on Northwind, and what would levelling move?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    applybooleanNoTrue to write the proposed moves. False, the default, returns the proposal without changing anything.
    expectedFingerprintstringNoThe plan fingerprint the proposal reported. A plan that changed since is refused rather than written over.
    notestringNoA note recorded with the applied moves.

    Reschedule delivery engagements plan

    Changes data

    atlas_delivery_engagements_plan_reschedule

    Reschedule the plan from its dependencies and constraints. By default it returns the proposed moves and changes nothing; send apply with the fingerprint the proposal reported to write them.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/plan/reschedule
    Example prompt
    What would change if we rescheduled the plan from next Monday?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    applybooleanNoTrue to write the proposed moves. False, the default, returns the proposal without changing anything.
    startsOnstringNoReschedule from this date, YYYY-MM-DD. Defaults to the plan start.
    expectedFingerprintstringNoThe plan fingerprint the proposal reported. A plan that changed since is refused rather than written over.
    notestringNoA note recorded with the applied moves.

    Get delivery engagements plan variance

    Read only

    atlas_delivery_engagements_plan_variance_get

    Compare the plan with the current baseline: how far each item and the whole plan has moved. Use this to answer "how far behind are we".

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/baselines/variance
    Example prompt
    How far behind the baseline is Northwind?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    List delivery engagements portal invites

    Read only

    atlas_delivery_engagements_portal_invites_list

    List the client portal invitations on an engagement: the CRM contact, access role, who invited them, when it was issued and expires, and whether it is outstanding, accepted, expired or revoked. The invitation tokens are never returned.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/portal-invites
    Example prompt
    Which client contacts have outstanding portal invitations on Northwind?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Record delivery engagements pricing assumptions breach

    Changes data

    atlas_delivery_engagements_pricing_assumptions_breach_record

    Record that a pricing assumption has been breached: what is true now, the commercial impact, and the change request that covers it. Returns the updated assumption.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/pricing-assumptions/{assumptionId}/breach
    Example prompt
    The client cannot provide test environments, record the breach against CR-12.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    assumptionIdstringYesThe assumption id.
    currentRealitystringYesWhat is true now, which breaks the assumption.
    commercialImpactstringNoThe commercial impact of the breach, as a decimal string.
    changeRequestIdstringNoThe id of the change request that covers it.

    Create delivery engagements pricing assumptions

    Changes data

    atlas_delivery_engagements_pricing_assumptions_create

    Record a pricing assumption the engagement was sold on, with the sold basis and the current reality. Returns the assumption.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/pricing-assumptions
    Example prompt
    Record that pricing assumed the client provides test environments.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    statementstringYesThe assumption the price rests on.
    soldBasisstringNoWhat the sale assumed.
    currentRealitystringNoWhat is true now.

    List delivery engagements pricing assumptions

    Read only

    atlas_delivery_engagements_pricing_assumptions_list

    List the pricing assumptions the engagement was sold on, with what the sale assumed, what is true now, and any breach recorded.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/pricing-assumptions
    Example prompt
    Which pricing assumptions have been breached?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Record delivery engagements procurement consumption

    Changes data

    atlas_delivery_engagements_procurement_consumption_record

    Record consumption against the purchase order, such as an invoice raised against it. Returns the record with the remaining value.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/procurement/consume
    Example prompt
    Record 40,000 consumed against the PO for the March invoice.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    amountstringYesThe amount as a decimal string, in the purchase order currency.
    notestringNoWhat the consumption is for, such as an invoice number.

    Get delivery engagements procurement

    Read only

    atlas_delivery_engagements_procurement_get

    Read the client procurement record of an engagement: supplier registration, purchase order number, value, consumption and expiry, invoicing portal and instructions, payment terms and billing contact.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/procurement
    Example prompt
    How much of the purchase order is left?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Set delivery engagements procurement

    Changes data

    atlas_delivery_engagements_procurement_set

    Write the client procurement record of an engagement. Only the fields sent change. Returns the record.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/procurement
    Example prompt
    Record PO 4500123 for 250,000 GBP expiring at the end of the year.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    supplierPortalstringNoThe client supplier portal.
    supplierRegistrationStatus"NOT_STARTED" | "REQUESTED" | "IN_PROGRESS" | "REGISTERED" | "REJECTED"NoWhere supplier registration stands.
    supplierIdstringNoThe supplier id the client assigned to the firm.
    poNumberstringNoThe purchase order number.
    poValuestringNoThe purchase order value as a decimal string.
    poCurrencystringNoThe ISO 4217 currency code of the purchase order.
    poIssuedAtstring (date-time)NoWhen the purchase order was issued, as an ISO 8601 date-time in UTC.
    poExpiresAtstring (date-time)NoWhen the purchase order expires, as an ISO 8601 date-time in UTC.
    poWarnAtPercentintegerNoThe consumption percentage at which to warn that the purchase order is running out.
    invoicingPortalstringNoThe portal invoices are submitted through.
    invoicingInstructionsstringNoHow the client wants to be invoiced.
    paymentTermsDaysintegerNoThe payment terms in days.
    billingContactNamestringNoThe name of the client billing contact.
    billingContactEmailstring (email)NoThe email address of the client billing contact.
    costCentrestringNoThe client cost centre to invoice against.
    requiresTimesheetApprovalbooleanNoWhether the client must approve timesheets before invoicing.
    timesheetApproverContactIdstringNoThe CRM contact id of the client contact who approves timesheets.
    notesstringNoNotes on the procurement arrangements.

    Get delivery engagements quality review

    Read only

    atlas_delivery_engagements_quality_review_get

    Read the engagement quality review of an engagement: why it is required, the reviewer, who appointed them, the unresolved matters and whether it is complete.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/quality-review
    Example prompt
    Who is the engagement quality reviewer on Northwind, and is the review complete?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Set delivery engagements raci cells in bulk

    Changes data

    atlas_delivery_engagements_raci_cells_bulk_set

    Set up to two hundred cells of the responsibility matrix in one request. Either every cell is written or none is. Returns the cells.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/raci/bulk
    Example prompt
    Fill in the matrix for all six workstreams from this table.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    cellsarray of objectYesThe cells to write, up to two hundred.

    Delete delivery engagements raci cells

    Destructive

    atlas_delivery_engagements_raci_cells_delete

    Remove one cell from the responsibility matrix. Returns the result of the removal.

    Scope
    delivery:write
    Calls
    DELETE /v1/engagements/{engagementId}/raci/{childId}
    Example prompt
    Remove Tom from the pricing deliverable in the matrix.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    raciCellIdstringYesThe RACI cell id.

    List delivery engagements raci cells

    Read only

    atlas_delivery_engagements_raci_cells_list

    Read the responsibility matrix of an engagement: every cell with its subject, party and letter under the decision model in use. Use this to answer "who is accountable for this deliverable".

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/raci
    Example prompt
    Who is accountable for each deliverable on this engagement?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Set delivery engagements raci cells

    Changes data

    atlas_delivery_engagements_raci_cells_set

    Set one cell of the responsibility matrix: a party and a letter against a subject. An existing cell for the same subject and party is replaced. Returns the cell.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/raci
    Example prompt
    Make Priya accountable for the final report.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    subjectType"PHASE" | "WORKSTREAM" | "OBJECTIVE" | "SCOPE_STATEMENT" | "DELIVERABLE" | "PLAN_ITEM" | "RAID_ITEM" | "MEETING" | "MEETING_SERIES" | "THREAD" | "INFO_REQUEST" | "CHANGE_REQUEST" | "STATUS_REPORT" | "STAKEHOLDER" | "BILLING_MILESTONE" | "SIGN_OFF" | "CHECK" | "LEGAL_INSTRUMENT" | "CLOSURE_ITEM" | "BENEFIT" | "ACCESS_PROVISION" | "COMMERCIAL_TERM" | "ANALYTICAL_ASSUMPTION" | "RESPONSIBILITY_AREA" | "FOLLOW_UP" | "CLIENT_PROCUREMENT" | "ENGAGEMENT"YesThe kind of engagement record it is about.
    subjectIdstringYesThe id of the engagement record it is about.
    subjectLabelstringNoA readable label for the record it is about.
    partyType"USER" | "CLIENT_CONTACT" | "EXTERNAL"YesWho the party is: an Atlas user, a client contact, or an external person.
    partyUserIdstringNoThe Atlas user id, when the party is a user.
    partyContactIdstringNoThe CRM contact id, when the party is a client contact.
    partyLabelstringNoA display name for the party, used when it is external.
    partyEmailstring (email)NoAn email address for the party, used when it is external.
    letter"R" | "A" | "S" | "C" | "I" | "V"YesThe responsibility letter: R responsible, A accountable, S supportive, C consulted, I informed, V verifier.
    daciLetter"D" | "A" | "C" | "I"NoThe letter under the DACI model: D driver, A approver, C contributor, I informed.
    rapidLetter"R" | "A" | "P" | "I" | "D"NoThe letter under the RAPID model: R recommend, A agree, P perform, I input, D decide.
    notestringNoA note on the cell.

    Update delivery engagements raci cells

    Changes data

    atlas_delivery_engagements_raci_cells_update

    Change the letter or the note on one responsibility matrix cell. Returns the updated cell.

    Scope
    delivery:write
    Calls
    PATCH /v1/engagements/{engagementId}/raci/{childId}
    Example prompt
    Change Sam from consulted to informed on the data model.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    raciCellIdstringYesThe RACI cell id.
    letter"R" | "A" | "S" | "C" | "I" | "V"NoThe responsibility letter: R responsible, A accountable, S supportive, C consulted, I informed, V verifier.
    notestring | nullNoA note on the cell, or null to clear it.

    Set delivery engagements raci decision model

    Changes data

    atlas_delivery_engagements_raci_decision_model_set

    Switch the decision model the responsibility matrix uses: RACI, RASCI, DACI or RAPID. Returns the matrix under the new model.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/raci/switch-model
    Example prompt
    Switch this engagement to DACI.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    model"RACI" | "RASCI" | "DACI" | "RAPID"YesThe decision model the matrix uses.

    Export delivery engagements raci

    Read only

    atlas_delivery_engagements_raci_export

    Render the responsibility matrix as a Markdown document, for the internal team or in the client-safe form. Returns the Markdown text, or a job ticket when the matrix is too large to render in one request.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/raci/export
    Example prompt
    Give me the RACI as a document I can paste into the kickoff pack.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    audience"INTERNAL" | "CLIENT"NoWho the output is for: INTERNAL shows everything, CLIENT shows only what may be shared with the client.
    subjectstringNoThe id of the one record the artifact is about, for an artifact that needs one.

    List delivery engagements raci parties

    Read only

    atlas_delivery_engagements_raci_parties_list

    List every party that appears in the responsibility matrix, with the key used to remove one. Use this to answer "who is on the matrix".

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/raci/parties
    Example prompt
    Who appears on the RACI for this engagement?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Remove delivery engagements raci parties

    Destructive

    atlas_delivery_engagements_raci_parties_remove

    Take one party off the whole responsibility matrix, removing every cell they hold. Use this when a person leaves the engagement. Returns what was removed.

    Scope
    delivery:write
    Calls
    DELETE /v1/engagements/{engagementId}/raci/party/{partyKey}
    Example prompt
    Take Tom off the RACI entirely, he has rolled off.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    partyKeystringYesThe party key, as returned by atlas_delivery_engagements_raci_parties_list.

    List delivery engagements raci subjects

    Read only

    atlas_delivery_engagements_raci_subjects_list

    List the engagement records that can appear as rows of the responsibility matrix: phases, workstreams, deliverables and the other subjects, with their ids.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/raci/subjects
    Example prompt
    What can I assign responsibilities against on this engagement?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Apply delivery engagements raci template

    Changes data

    atlas_delivery_engagements_raci_template_apply

    Apply a responsibility matrix template to the engagement, and optionally fill the named seats from the engagement team. Returns the resulting cells.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/raci/apply-template
    Example prompt
    Apply the standard transformation RACI template and fill the seats.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    slugstringYesThe slug of the template to apply.
    fillSeatsbooleanNoWhen true, fill the named seats from the engagement team after applying the template.

    Validate delivery engagements raci

    Read only

    atlas_delivery_engagements_raci_validate

    Check the responsibility matrix for structural problems, such as a subject with no one accountable or with more than one. Returns the findings; an empty list means none were found.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/raci/validate
    Example prompt
    Is anything missing an accountable owner in the RACI?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Set delivery engagements RAG

    Changes data

    atlas_delivery_engagements_rag_set

    Set the traffic lights of an engagement: overall, schedule, budget, scope, quality, resourcing and client. Send only the lights that change, with the reason, which is recorded on the timeline. Returns the engagement with its new ratings.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{id}/rag
    Example prompt
    Set the Northwind schedule light to amber because the data load slipped.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    overallRag"GREEN" | "AMBER" | "RED" | "GREY"NoThe overall traffic light.
    scheduleRag"GREEN" | "AMBER" | "RED" | "GREY"NoThe schedule traffic light.
    budgetRag"GREEN" | "AMBER" | "RED" | "GREY"NoThe budget traffic light.
    scopeRag"GREEN" | "AMBER" | "RED" | "GREY"NoThe scope traffic light.
    qualityRag"GREEN" | "AMBER" | "RED" | "GREY"NoThe quality traffic light.
    resourceRag"GREEN" | "AMBER" | "RED" | "GREY"NoThe resourcing traffic light.
    clientRag"GREEN" | "AMBER" | "RED" | "GREY"NoThe client relationship traffic light.
    reasonstringYesWhy the ratings changed, recorded on the timeline.

    Get delivery engagements RAID items ageing

    Read only

    atlas_delivery_engagements_raid_items_ageing_get

    Report how long open RAID items have been open, oldest first, optionally for one kind. Use this to answer "which issues have been sitting there longest".

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/raid/ageing
    Example prompt
    Which open issues are the oldest on this engagement?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    kind"RISK" | "ASSUMPTION" | "ISSUE" | "DEPENDENCY" | "DECISION"NoOnly items of this kind.
    limitintegerNoThe largest number of rows to return.

    Create delivery engagements RAID items in bulk

    Changes data

    atlas_delivery_engagements_raid_items_bulk_create

    Log up to fifty RAID items on one engagement in a single request. Either every item is created or none is. Returns the created items.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/raid/bulk
    Example prompt
    Log these five risks from the workshop on the engagement.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    itemsarray of objectYesThe items to log, up to fifty.

    Review delivery engagements RAID items in bulk

    Changes data

    atlas_delivery_engagements_raid_items_bulk_review

    Record a review of several RAID items at once, optionally with a shared note and a new review cadence. Each item gets its next review date moved forward. Returns the reviewed items.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/raid/bulk-review
    Example prompt
    Mark all the risks we went through in steering as reviewed.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    itemIdsarray of stringYesThe ids of the RAID items that were reviewed.
    notestringNoA note recorded with the change.
    reviewCadenceDaysintegerNoHow often the item must be reviewed, in days.

    Create delivery engagements RAID items change requests

    Changes data

    atlas_delivery_engagements_raid_items_change_requests_create

    Raise a draft change request from a RAID item and link the two. The change request is created as a draft; assessing and approving it stays with people. Returns the change request.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/raid/{childId}/convert-to-change-request
    Example prompt
    Raise a change request from the scope creep issue.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    raidItemIdstringYesThe RAID item id.
    titlestringNoThe change request title. Defaults to the item title.
    descriptionstringNoThe change request description.
    type"SCOPE" | "SCHEDULE" | "COST" | "RESOURCE" | "QUALITY" | "CONTRACT" | "ASSUMPTION" | "TECHNICAL"NoWhat kind of change this is.
    urgency"LOW" | "MEDIUM" | "HIGH" | "CRITICAL"NoHow urgent it is.
    workstreamIdstringNoThe id of the engagement workstream it belongs to.
    requiresClientApprovalbooleanNoWhether the client must approve the change.
    rebaselineRequiredbooleanNoWhether the plan must be rebaselined if the change is approved.

    Convert delivery engagements RAID items

    Changes data

    atlas_delivery_engagements_raid_items_convert

    Change the kind of a RAID item, for example when a risk has occurred and becomes an issue. The history is kept. Returns the converted item.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/raid/{childId}/convert
    Example prompt
    The supplier risk has happened, turn it into an issue.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    raidItemIdstringYesThe RAID item id.
    to"RISK" | "ASSUMPTION" | "ISSUE" | "DEPENDENCY" | "DECISION"YesThe kind to convert the item to.

    Create delivery engagements RAID items

    Changes data

    atlas_delivery_engagements_raid_items_create

    Log a risk, assumption, issue, dependency or decision on an engagement register. An issue has already happened, so its probability is always recorded as certain regardless of what is passed.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/raid
    Example prompt
    Log a risk that the data migration window may not hold.

    Arguments

    FieldTypeRequiredDescription
    idstringYesThe engagement id.
    kind"RISK" | "ASSUMPTION" | "ISSUE" | "DEPENDENCY" | "DECISION"YesRisk, assumption, issue, dependency or decision.
    titlestringYesThe item, in one line.
    descriptionstringNoThe detail behind it.
    probabilityintegerNoLikelihood, 1 to 5. An issue has already happened, so it is always 5.
    impactintegerNoConsequence, 1 to 5.

    Delete delivery engagements RAID items

    Destructive

    atlas_delivery_engagements_raid_items_delete

    Delete a RAID item that was logged in error. An item that has a history worth keeping should be voided instead, with atlas_delivery_engagements_raid_items_void. Returns the result of the deletion.

    Scope
    delivery:write
    Calls
    DELETE /v1/engagements/{engagementId}/raid/{childId}
    Example prompt
    Delete the duplicate risk I logged a minute ago.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    raidItemIdstringYesThe RAID item id.

    List delivery engagements RAID items due reviews

    Read only

    atlas_delivery_engagements_raid_items_due_reviews_list

    List RAID items whose review falls due within the given number of days, including those already overdue. Use this to prepare a risk review.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/raid/due-reviews
    Example prompt
    Which risks are due for review this week?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    withinDaysintegerNoHow many days ahead to look for reviews falling due.
    limitintegerNoThe largest number of rows to return.

    Escalate delivery engagements RAID items

    Changes data

    atlas_delivery_engagements_raid_items_escalate

    Escalate a RAID item to a named person, an escalation level, or an escalation path, with the reason. The escalation is recorded on the item history. Returns the updated item.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/raid/{childId}/escalate
    Example prompt
    Escalate the budget risk to the engagement partner.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    raidItemIdstringYesThe RAID item id.
    reasonstringYesWhy the item is being escalated.
    toUserIdstringNoThe Atlas user id of the person to escalate to.
    levelintegerNoThe escalation level, from 1 to 4.
    escalationPathIdstringNoThe id of an escalation path defined on this engagement.

    List delivery engagements RAID items events

    Read only

    atlas_delivery_engagements_raid_items_events_list

    Read the history of one RAID item: every status change, score change, review, escalation and share, with who did it and when.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/raid/{childId}/events
    Example prompt
    What has happened to the vendor risk since it was logged?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    raidItemIdstringYesThe RAID item id.

    Export delivery engagements RAID items

    Read only

    atlas_delivery_engagements_raid_items_export

    Render the RAID log as a Markdown document, for the internal team or in the client-safe form. Returns the Markdown text, or a job ticket when the log is too large to render in one request; poll a ticket with atlas_delivery_engagements_export_jobs_get.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/raid/export
    Example prompt
    Give me the client version of the RAID log.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    audience"INTERNAL" | "CLIENT"NoWho the output is for: INTERNAL shows everything, CLIENT shows only what may be shared with the client.
    subjectstringNoThe id of the one record the artifact is about, for an artifact that needs one.

    Get delivery engagements RAID items

    Read only

    atlas_delivery_engagements_raid_items_get

    Read one RAID item in full: its kind, status, scores, heat band, owner, response plans, review dates and client sharing state. Use this after listing the register to answer a question about one risk, assumption, issue, dependency or decision.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/raid/{childId}
    Example prompt
    Show me the full detail of the data migration risk.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    raidItemIdstringYesThe RAID item id.

    Get delivery engagements RAID items heatmap

    Read only

    atlas_delivery_engagements_raid_items_heatmap_get

    Read the probability by impact heat map of open risks and issues, with the count in each cell. Use this to answer "how exposed is this engagement".

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/raid/heatmap
    Example prompt
    Show me the risk heat map for this engagement.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Import delivery engagements RAID items

    Changes data

    atlas_delivery_engagements_raid_items_import

    Seed the RAID register from the risk log of the delivery project linked to the engagement. Items already imported are not duplicated. Returns what was imported.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/raid/import-from-project
    Example prompt
    Pull the risks from the linked project into the engagement register.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    includeClosedbooleanNoWhen true, also import risks already closed in the project.
    limitintegerNoThe largest number of project risks to import.

    List delivery engagements RAID items

    Read only

    atlas_delivery_engagements_raid_items_list

    Read the risk, assumption, issue, dependency and decision register for one engagement, with scores and heat bands. Use this to answer "what is going wrong" or "what are the severe risks". Pass `nextCursor` back as `cursor` for the next page.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/raid
    Example prompt
    What are the severe risks on Northwind?

    Arguments

    FieldTypeRequiredDescription
    idstringYesThe engagement id.
    limitintegerNoPage size, 1 to 200.
    cursorstringNoThe nextCursor of the previous page. Leave it out for the first page.

    Resolve delivery engagements RAID items

    Changes data

    atlas_delivery_engagements_raid_items_resolve

    Close a RAID item as resolved or closed, with a resolution summary. The route also accepts, rejects, validates and invalidates items, but each of those is a person putting their name to a judgement, so this tool offers only RESOLVED and CLOSED. Returns the updated item.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/raid/{childId}/resolve
    Example prompt
    Close the access issue as resolved, access was granted on Monday.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    raidItemIdstringYesThe RAID item id.
    status"RESOLVED" | "CLOSED"YesThe closing status: RESOLVED when the item was dealt with, CLOSED when it no longer applies.
    resolutionSummarystringYesHow it was resolved, in words a reviewer can read later.

    Review delivery engagements RAID items

    Changes data

    atlas_delivery_engagements_raid_items_review

    Record that a RAID item was reviewed, with an optional note and a new review cadence. The next review date moves forward. Returns the updated item.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/raid/{childId}/review
    Example prompt
    Mark the migration risk as reviewed with a note that nothing changed.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    raidItemIdstringYesThe RAID item id.
    notestringNoA note recorded with the change.
    reviewCadenceDaysintegerNoHow often the item must be reviewed, in days.

    Score delivery engagements RAID items

    Changes data

    atlas_delivery_engagements_raid_items_score

    Rescore a RAID item: its probability and impact, and optionally the residual probability and impact after the response. The heat band is recalculated. Returns the updated item.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/raid/{childId}/score
    Example prompt
    Raise the probability of the resourcing risk to 4.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    raidItemIdstringYesThe RAID item id.
    probabilityintegerNoLikelihood, from 1 to 5. An issue has already happened, so the API always records it as 5.
    impactintegerNoConsequence, from 1 to 5.
    residualProbabilityintegerNoLikelihood after the response takes effect, from 1 to 5.
    residualImpactintegerNoConsequence after the response takes effect, from 1 to 5.
    notestringNoA note recorded with the change.

    Revoke delivery engagements RAID items share

    Destructive

    atlas_delivery_engagements_raid_items_share_revoke

    Stop sharing a RAID item with the client, with the reason. The item disappears from client views and client exports. Returns the updated item.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/raid/{childId}/unshare
    Example prompt
    Stop sharing the pricing issue with the client.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    raidItemIdstringYesThe RAID item id.
    reasonstringYesWhy the item is no longer shared with the client.

    Get delivery engagements RAID items summary

    Read only

    atlas_delivery_engagements_raid_items_summary_get

    Read the RAID register summary: counts by kind, status and heat band, overdue reviews, and escalated items. Use this for a quick picture before reading individual items.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/raid/summary
    Example prompt
    Summarise the RAID register.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Create delivery engagements RAID items tasks

    Changes data

    atlas_delivery_engagements_raid_items_tasks_create

    Create an Atlas task from a RAID item, so the action to address it is tracked with the rest of the work. Returns the created task.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/raid/{childId}/convert-to-task
    Example prompt
    Create a task for Sam to chase the data access dependency by Friday.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    raidItemIdstringYesThe RAID item id.
    titlestringNoThe task title. Defaults to the item title.
    bodystringNoThe task description.
    assigneeUserIdstringNoThe Atlas user id of the person to assign the task to.
    dueAtstring (date-time)NoWhen the task is due, as an ISO 8601 date-time in UTC.

    Transition delivery engagements RAID items

    Changes data

    atlas_delivery_engagements_raid_items_transition

    Move a RAID item between its working states: open, in progress, mitigating, or monitoring. Closing states are set with atlas_delivery_engagements_raid_items_resolve. Returns the updated item.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/raid/{childId}/status
    Example prompt
    Move the vendor risk to mitigating.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    raidItemIdstringYesThe RAID item id.
    status"OPEN" | "IN_PROGRESS" | "MITIGATING" | "MONITORING"YesThe working state to move the item to.
    notestringNoA note recorded with the change.

    Update delivery engagements RAID items

    Changes data

    atlas_delivery_engagements_raid_items_update

    Change the fields of one RAID item, such as its owner, response, mitigation and contingency plans, review cadence, dates, cost and schedule impact, or decision rationale. Only the fields sent change; send null to clear a field. Returns the updated item.

    Scope
    delivery:write
    Calls
    PATCH /v1/engagements/{engagementId}/raid/{childId}
    Example prompt
    Set the mitigation plan on the vendor risk and make Priya the owner.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    raidItemIdstringYesThe RAID item id.
    titlestringNoA short title, in one line.
    descriptionstring | nullNoThe detail behind it, or null to clear it.
    category"COMMERCIAL" | "SCHEDULE" | "RESOURCE" | "TECHNICAL" | "DATA" | "SECURITY" | "REGULATORY" | "LEGAL" | "THIRD_PARTY" | "CLIENT_READINESS" | "CHANGE" | "QUALITY" | "REPUTATIONAL" | "HEALTH_SAFETY" | "ENVIRONMENTAL"NoThe category it belongs to.
    ownerUserIdstring | nullNoThe Atlas user id of the person who owns it, or null to clear it.
    workstreamIdstring | nullNoThe id of the engagement workstream it belongs to, or null to clear it.
    response"AVOID" | "MITIGATE" | "TRANSFER" | "ACCEPT" | "EXPLOIT" | "ENHANCE" | "SHARE" | "ESCALATE" | nullNoThe chosen risk response, or null to clear it.
    mitigationPlanstring | nullNoWhat is being done to reduce the risk, or null to clear it.
    contingencyPlanstring | nullNoWhat happens if the risk occurs, or null to clear it.
    triggerConditionstring | nullNoThe condition that shows the risk is occurring, or null to clear it.
    escalationTriggerstring | nullNoThe condition that requires escalation, or null to clear it.
    escalationThresholdScoreinteger | nullNoThe score at or above which the item escalates, from 1 to 25, or null to clear it.
    reviewCadenceDaysinteger | nullNoHow often the item must be reviewed, in days, or null to clear it.
    targetResolutionAtstring (date-time) | nullNoWhen it should be resolved by, as an ISO 8601 date-time in UTC, or null to clear it.
    impactDaysinteger | nullNoThe schedule impact in days, or null to clear it.
    impactCoststring | nullNoThe cost impact as a decimal string with up to two decimal places, or null to clear it.
    assumptionValidBystring (date-time) | nullNoWhen an assumption must be validated by, as an ISO 8601 date-time in UTC, or null to clear it.
    assumptionEvidencestring | nullNoThe evidence that validates the assumption, or null to clear it.
    dependencyNeededBystring (date-time) | nullNoWhen a dependency is needed by, as an ISO 8601 date-time in UTC, or null to clear it.
    dependencyIsExternalbooleanNoWhether the dependency is on a party outside the firm.
    dependencyOwnerPartyType"USER" | "CLIENT_CONTACT" | "EXTERNAL" | nullNoWho owns the dependency: an Atlas user, a client contact, or an external party, or null to clear it.
    dependencyOwnerUserIdstring | nullNoThe Atlas user id of the dependency owner, when the owner is a user, or null to clear it.
    dependencyOwnerContactIdstring | nullNoThe CRM contact id of the dependency owner, when the owner is a client contact, or null to clear it.
    dependencyOwnerLabelstring | nullNoA display name for the dependency owner, when there is no user or contact record, or null to clear it.
    decisionRationalestring | nullNoWhy the decision was taken, or null to clear it.
    alternativesConsideredstring | nullNoThe alternatives that were considered, or null to clear it.
    decisionReversibility"REVERSIBLE" | "PARTIALLY_REVERSIBLE" | "IRREVERSIBLE" | nullNoWhether the decision can be reversed, or null to clear it.

    Void delivery engagements RAID items

    Destructive

    atlas_delivery_engagements_raid_items_void

    Void a RAID item that should never have been raised, with the reason. A voided item stays in the history but leaves every count. Returns the updated item.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/raid/{childId}/void
    Example prompt
    Void the duplicate issue, it was logged twice.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    raidItemIdstringYesThe RAID item id.
    reasonstringYesWhy the item should never have been raised.

    Calculate delivery engagements ramp profiles allocation

    Read only

    atlas_delivery_engagements_ramp_profiles_allocation_calculate

    Calculate the effective allocation of a planned allocation in a given week under a ramp profile.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/ramp-profiles/{rampId}/effective-allocation
    Example prompt
    What is a full-time joiner actually worth in week 2 under this ramp?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    rampIdstringYesThe ramp profile id.
    allocationnumberYesThe planned allocation as a fraction of full time, from 0 to 1.
    weekintegerYesThe engagement week, counting from 1.

    Create delivery engagements ramp profiles

    Changes data

    atlas_delivery_engagements_ramp_profiles_create

    Define a ramp profile: the curve type, productivity by week, onboarding days that are not billable, learning and shadowing hours, handover overlap and ramp-down taper. Returns the profile.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/ramp-profiles
    Example prompt
    Define a ramp where a joiner is at 50, 75 then 100 percent over three weeks.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    teamMemberIdstringNoThe id of the engagement team member the ramp profile applies to.
    curveTypestringYesThe shape of the ramp, such as LINEAR or STEP.
    productivityByWeekarray of integerYesProductivity as a percentage for each week, first week first.
    onboardingDaysNonBillableintegerNoHow many onboarding days are not billable.
    clientContextLearningHoursintegerNoHours a joiner spends learning the client context.
    shadowingHoursintegerNoHours a joiner spends shadowing.
    handoverOverlapDaysintegerNoHow many days an outgoing and incoming person overlap.
    handoverBillablebooleanNoWhether handover time is billable.
    handoverCostAbsorbedstringNoThe handover cost the firm absorbs, as a decimal string.
    rampDownTaperarray of integerNoAllocation as a percentage for each week of ramp-down.
    knowledgeTransferHoursintegerNoHours of knowledge transfer on ramp-down.

    List delivery engagements ramp profiles

    Read only

    atlas_delivery_engagements_ramp_profiles_list

    List the ramp profiles of an engagement: how productivity builds week by week for a joiner, and the handover and ramp-down terms.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/ramp-profiles
    Example prompt
    What ramp profiles are defined on this engagement?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    List delivery engagements rate card entries

    Read only

    atlas_delivery_engagements_rate_card_entries_list

    List the bill rates on a rate card by grade and role. The internal cost rates are never returned by this tool, because they are the firm's own commercial position.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/commercials/rate-cards/{childId}/entries
    Example prompt
    What are the bill rates on the UK rate card?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    rateCardIdstringYesThe rate card id.

    Create delivery engagements rate cards

    Changes data

    atlas_delivery_engagements_rate_cards_create

    Add a rate card to an engagement, with its currency, geography and the dates it applies. Add its rates afterwards. Returns the rate card.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/commercials/rate-cards
    Example prompt
    Add a UK rate card in pounds from January.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    namestringYesThe rate card name.
    currencystringNoThe ISO 4217 currency code, for example USD.
    geographystringNoWhere the rates apply.
    effectiveFromstring (date-time)YesWhen the rate card takes effect, as an ISO 8601 UTC date-time.
    effectiveTostring (date-time)NoWhen the rate card stops applying, as an ISO 8601 UTC date-time.
    isDefaultbooleanNoWhether this is the default rate card for the engagement.

    List delivery engagements rate cards

    Read only

    atlas_delivery_engagements_rate_cards_list

    List the rate cards of one engagement with their currency and dates.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/commercials/rate-cards
    Example prompt
    Which rate cards does Northwind use?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Get delivery engagements readiness

    Read only

    atlas_delivery_engagements_readiness_get

    Answer "why can this engagement not start yet". Returns every blocker at once: an acceptance decision not taken or expired, a screening check outstanding or lapsed, a legal instrument not executed, or a quality review still owed. An empty list means nothing is blocking it.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/acceptance/readiness
    Example prompt
    Can the Northwind engagement start yet?

    Arguments

    FieldTypeRequiredDescription
    idstringYesThe engagement id.

    Create delivery engagements regulatory obligations

    Changes data

    atlas_delivery_engagements_regulatory_obligations_create

    Record one regulatory obligation on an engagement that the catalogue does not cover, with its regime, text, trigger, deadline, evidence requirement and owner. Returns the obligation.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/regulatory-obligations
    Example prompt
    Record a 72-hour notification obligation to the regulator, starting from the incident this morning.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    regimestringYesThe regime the obligation comes from.
    obligationTextstringYesWhat the obligation requires.
    triggerstringYesThe event that starts the clock.
    dueWithinHoursintegerNoHow many hours after the trigger it falls due.
    triggeredAtstring (date-time)NoWhen the trigger happened, as an ISO 8601 date-time in UTC.
    dueAtstring (date-time)NoA fixed due date, as an ISO 8601 date-time in UTC. It wins over the computed one.
    evidenceRequiredbooleanNoWhether the obligation can only be marked met with a document attached.
    breachConsequencestringNoWhat follows if it is breached.
    ownerUserIdstringNoThe Atlas user id of the owner.

    List delivery engagements regulatory obligations due

    Read only

    atlas_delivery_engagements_regulatory_obligations_due_list

    List the regulatory obligations on an engagement that fall due within a window, together with every one already overdue. Use this to answer "what regulatory deadlines are coming up".

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/regulatory-obligations/due
    Example prompt
    Which regulatory deadlines fall due in the next 48 hours?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    hoursintegerNoThe window ahead, in hours. The default is 168, one week.

    Generate delivery engagements regulatory obligations

    Changes data

    atlas_delivery_engagements_regulatory_obligations_generate

    Create the standard obligations of one or more regulatory regimes on an engagement from the catalogue, with their deadlines counted from when the triggering event happened. Returns the obligations created.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/regulatory-obligations/seed
    Example prompt
    Add the DORA incident reporting obligations, triggered at 09:00 today.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    regimesarray of stringYesThe regimes whose obligations apply.
    triggeredAtstring (date-time)NoWhen the triggering event happened, as an ISO 8601 date-time in UTC. Deadlines are counted from it.
    ownerUserIdstringNoThe Atlas user id of the person who owns the obligations.

    List delivery engagements regulatory obligations

    Read only

    atlas_delivery_engagements_regulatory_obligations_list

    List the regulatory obligations on an engagement, such as breach notification and reporting deadlines, with their regime, trigger, due date, owner and status. Filter by status or regime.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/regulatory-obligations
    Example prompt
    List the open GDPR obligations on this engagement.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    status"OPEN" | "IN_PROGRESS" | "MET" | "WAIVED" | "BREACHED"NoFilter to one status.
    regimestringNoFilter to one regime, such as GDPR.
    limitintegerNoThe most obligations to return (1..500).

    Transition delivery engagements regulatory obligations

    Changes data

    atlas_delivery_engagements_regulatory_obligations_transition

    Move a regulatory obligation between open and in progress, optionally attaching evidence. Whether an obligation was met, breached or waived is a claim about a legal obligation, so a person records it in Atlas. Returns the obligation.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/regulatory-obligations/{childId}/status
    Example prompt
    Mark the breach notification obligation as in progress; the draft filing is attached.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    obligationIdstringYesThe regulatory obligation id.
    status"OPEN" | "IN_PROGRESS"YesThe new status.
    evidenceAttachmentIdstringNoThe id of an attachment to hold as evidence for the obligation.

    Draft delivery engagements reliance letters

    Changes data

    atlas_delivery_engagements_reliance_letters_draft

    Record a draft reliance letter on an engagement: the relying party, its relationship, the scope and deliverables relied on, the liability caps, fee, indemnities and dates. The letter is recorded unissued; issuing it stays with a person. Money is a decimal string. Returns the letter.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/reliance-letters
    Example prompt
    Draft a reliance letter for the lender with a 1,000,000 cap.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    partyRelyingstringYesThe party that will rely on the work.
    relationshipstringYesThe relationship of the relying party to the client, such as LENDER.
    scopeOfReliancestringNoWhat the party may rely on, and for what purpose.
    deliverableIdsarray of stringNoThe deliverables relied on.
    asAtDatestring (date-time)NoThe date the reliance speaks as at, as an ISO 8601 date-time in UTC.
    liabilityCapToThirdPartystringNoThe liability cap to this party, as a decimal string.
    aggregateCapAcrossAllPartiesstringNoThe aggregate cap across every relying party, as a decimal string. Without it the per-party caps are unlimited in total.
    currencystringNoThe three-letter currency code.
    feeChargedForReliancestringNoThe fee charged for reliance, as a decimal string.
    indemnityFromClientbooleanNoWhether the client indemnifies the firm.
    holdHarmlessFromRelyingPartybooleanNoWhether the relying party holds the firm harmless.
    noUpdateObligationClausebooleanNoWhether the letter states there is no obligation to update it.
    insurerNotifiedAtstring (date-time)NoWhen the professional indemnity insurer was notified, as an ISO 8601 date-time in UTC.
    expiresAtstring (date-time)NoWhen the reliance expires, as an ISO 8601 date-time in UTC.

    Get delivery engagements reliance letters exposure

    Read only

    atlas_delivery_engagements_reliance_letters_exposure_get

    Read the liability exposure of an engagement across every reliance letter it has issued: the caps to each party, the aggregate cap, and any letter with no aggregate cap, which is unlimited.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/reliance-letters/exposure
    Example prompt
    What is our total liability exposure from reliance letters on Northwind?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    List delivery engagements reliance letters

    Read only

    atlas_delivery_engagements_reliance_letters_list

    List the reliance letters on an engagement: each relying party, the scope of reliance, the caps, indemnities, dates and whether it has been issued.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/reliance-letters
    Example prompt
    Which reliance letters exist on the Northwind due diligence?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Reopen delivery engagements

    Changes data

    atlas_delivery_engagements_reopen

    Reopen a closed engagement, with the reason. Requires the owner or administrator role. Returns the engagement.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/closure/reopen
    Example prompt
    Reopen the closed Contoso engagement for the warranty fix.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    reasonstringYesWhy the engagement is reopened, recorded on the audit trail.

    Get delivery engagements report dating readiness

    Read only

    atlas_delivery_engagements_report_dating_readiness_get

    Answer "can the report on this engagement be dated yet". Returns every reason it cannot at once, such as an incomplete quality review or an open difference of opinion. An empty list means nothing is holding it.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/report-dating-readiness
    Example prompt
    Can we date the audit report for Acme yet?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Assign delivery engagements responsibility areas

    Changes data

    atlas_delivery_engagements_responsibility_areas_assign

    Fill the named seats of the responsibility areas from the engagement team, following the playbook. Adding a person to the team never does this on its own, so nobody becomes accountable by accident. Returns the areas with their seats.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/responsibility-areas/fill-seats
    Example prompt
    Fill the responsibility seats from the team we have staffed.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Create delivery engagements responsibility areas

    Changes data

    atlas_delivery_engagements_responsibility_areas_create

    Add a responsibility area to an engagement, with a stable key and a label. Returns the created area.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/responsibility-areas
    Example prompt
    Add a responsibility area for data protection.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    keystringYesA stable key for the area, unique within the engagement.
    labelstringYesThe name of the area, as people read it.

    Delete delivery engagements responsibility areas

    Destructive

    atlas_delivery_engagements_responsibility_areas_delete

    Remove a responsibility area from an engagement. Returns the result of the removal.

    Scope
    delivery:write
    Calls
    DELETE /v1/engagements/{engagementId}/responsibility-areas/{childId}
    Example prompt
    Remove the procurement responsibility area.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    areaIdstringYesThe responsibility area id.

    List delivery engagements responsibility areas

    Read only

    atlas_delivery_engagements_responsibility_areas_list

    List the responsibility areas of an engagement, in order, with who holds each seat.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/responsibility-areas
    Example prompt
    What responsibility areas are defined on this engagement?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Reorder delivery engagements responsibility areas

    Changes data

    atlas_delivery_engagements_responsibility_areas_reorder

    Set the order of the responsibility areas, by sending every area id first to last. Returns the areas in their new order.

    Scope
    delivery:write
    Calls
    PUT /v1/engagements/{engagementId}/responsibility-areas/order
    Example prompt
    Put the data protection area first.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    orderedIdsarray of stringYesEvery responsibility area id, first to last.

    Update delivery engagements responsibility areas

    Changes data

    atlas_delivery_engagements_responsibility_areas_update

    Rename a responsibility area. The key stays the same, so references to it are unaffected. Returns the updated area.

    Scope
    delivery:write
    Calls
    PATCH /v1/engagements/{engagementId}/responsibility-areas/{childId}
    Example prompt
    Rename the security area to information security.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    areaIdstringYesThe responsibility area id.
    labelstringYesThe new name of the area.

    Restore delivery engagements

    Changes data

    atlas_delivery_engagements_restore

    Restore an archived engagement to the default lists. Returns the restored engagement.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{id}/restore
    Example prompt
    Bring the archived Contoso pilot back.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    List delivery engagements revenue events

    Read only

    atlas_delivery_engagements_revenue_events_list

    List the revenue recognition events of one engagement, newest first.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/commercials/revrec-events
    Example prompt
    What revenue recognition events has Northwind had?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    eventType"MILESTONE_ACCEPTED" | "DEEMED_ACCEPTANCE_ELAPSED" | "DELIVERABLE_SIGNED_OFF" | "PERIOD_END" | "COST_INCURRED" | "UNITS_DELIVERED" | "GO_LIVE" | "WARRANTY_EXPIRED" | "SUCCESS_CRITERIA_VERIFIED" | "CONTRACT_MODIFICATION_APPROVED" | "TERMINATION"NoFilter to one event type.
    limitintegerNoPage size (1..500).

    Get delivery engagements review checklists

    Read only

    atlas_delivery_engagements_review_checklists_get

    Read the checklist of a deliverable review with the answer to each question.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/deliverables/{childId}/reviews/{itemId}/checklist
    Example prompt
    Show me the quality review checklist for the operating model.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    deliverableIdstringYesThe deliverable id.
    reviewIdstringYesThe review id.

    Set delivery engagements review checklists

    Changes data

    atlas_delivery_engagements_review_checklists_set

    Replace the questions of a deliverable review checklist with the list sent. Returns the checklist.

    Scope
    delivery:write
    Calls
    PUT /v1/engagements/{engagementId}/deliverables/{childId}/reviews/{itemId}/checklist
    Example prompt
    Use these ten questions as the review checklist.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    deliverableIdstringYesThe deliverable id.
    reviewIdstringYesThe review id.
    itemsarray of objectYesEvery question of the checklist, in order.

    List delivery engagements rotation register

    Read only

    atlas_delivery_engagements_rotation_register_list

    Read the partner rotation register for one client: each person, their role, the rule that applies, the years served and when they must rotate off. Use this to answer "is the audit partner due to rotate".

    Scope
    delivery:read
    Calls
    GET /v1/engagements/rotation-register
    Example prompt
    Is the audit partner for Acme due to rotate?

    Arguments

    FieldTypeRequiredDescription
    clientIdstringYesThe client id, which is the CRM account id.

    Record delivery engagements rotation register

    Changes data

    atlas_delivery_engagements_rotation_register_record

    Record the years a person has served a client in a role on the partner rotation register, under a jurisdiction rule. An existing entry for the same person, client and role is replaced. Returns the rotation status that follows.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/rotation-register
    Example prompt
    Record that Sam has served Acme as engagement partner since 2022.

    Arguments

    FieldTypeRequiredDescription
    personIdstringYesThe Atlas user id of the person.
    clientIdstringYesThe client id, which is the CRM account id.
    rolestringYesThe role served, such as ENGAGEMENT_PARTNER.
    jurisdictionRuleIdstringYesThe rotation rule id, from the rotation rules list.
    firstYearServedintegerYesThe first year the person served the client in the role.
    yearsServedintegerNoHow many years they have served. The default is one.

    List delivery engagements rotation rules

    Read only

    atlas_delivery_engagements_rotation_rules_list

    List the partner rotation rules Atlas knows, by jurisdiction and role: the most years a person may serve and the cooling-off years that follow. Use the rule id when recording service on the rotation register.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/rotation-rules
    Example prompt
    What partner rotation rules apply in the UK?

    Arguments

    This tool takes no arguments.

    Create delivery engagements scope statements

    Changes data

    atlas_delivery_engagements_scope_statements_create

    Add a scope statement to an engagement, either something in scope or an explicit exclusion. Returns the new statement.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/scope
    Example prompt
    Record that payroll integration is out of scope.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    inScopebooleanYesTrue for an in-scope statement, false for an explicit exclusion.
    statementstringYesWhat is in scope, or what is excluded.
    positionintegerNoWhere it sits in the list, from 0.
    clientVisiblebooleanNoWhether the client can see this in the portal.

    List delivery engagements scope statements

    Read only

    atlas_delivery_engagements_scope_statements_list

    List the scope of one engagement: what is in scope and what is explicitly excluded. Use this to answer "is this in scope".

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/scope
    Example prompt
    Is warehouse integration in scope on Northwind?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    List delivery engagements screening runs

    Read only

    atlas_delivery_engagements_screening_runs_list

    List the sanctions and politically exposed person screening runs on an engagement: the subject, the lists screened, the provider, each hit with its disposition and second approval, and whether monitoring is ongoing.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/screening
    Example prompt
    Show the sanctions screening runs for this client.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Record delivery engagements screening runs

    Changes data

    atlas_delivery_engagements_screening_runs_record

    Record the result of a screening run against an acceptance check: the subject, the lists screened, the provider and list version, and every hit it returned. Hits are recorded undisposed; deciding whether a hit is a true match stays with a person. Returns the run.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/screening
    Example prompt
    Record the sanctions screen we just ran on Acme Holdings against OFAC and the UN list, with its two hits.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    checkIdstringYesThe acceptance check id the run satisfies.
    subjectType"ENTITY" | "INDIVIDUAL" | "VESSEL" | "AIRCRAFT"YesWhat kind of subject was screened.
    subjectNamestringYesThe name that was screened.
    listsScreenedarray of stringYesThe lists screened against, at least one.
    providerstringNoThe screening provider.
    listVersionDatestringNoThe date of the list version used.
    fuzzyThresholdstringNoThe fuzzy match threshold used, such as 0.85.
    hitsarray of objectNoThe hits the run returned, up to five hundred.
    ongoingMonitoringbooleanNoWhether the subject is under ongoing monitoring.
    licenceRequiredbooleanNoWhether a sanctions licence is required.
    licenceReferencestringNoThe reference of the licence held.

    Create delivery engagements series meetings

    Changes data

    atlas_delivery_engagements_series_meetings_create

    Schedule the next meeting of a recurring series, taking its people, quorum rules and minutes rules from the series. Returns the new meeting.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/meetings/from-series/{seriesId}
    Example prompt
    Schedule the next Northwind steering committee.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    seriesIdstringYesThe meeting series id.
    scheduledAtstring (date-time)YesWhen the meeting is scheduled, as an ISO 8601 UTC date-time.
    meetingTitlestringNoThe meeting title.
    occurrenceKeystringNoA key that identifies this occurrence in the series, so it is not scheduled twice.
    durationMinintegerNoThe length in minutes.

    Request delivery engagements sign offs

    Changes data

    atlas_delivery_engagements_sign_offs_request

    Ask the client signatory to sign off a deliverable, by the method chosen, with a due date and an optional lapse into deemed acceptance. Returns the sign-off request.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/deliverables/{childId}/sign-off
    Example prompt
    Ask the Northwind sponsor to sign off the operating model by Friday.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    deliverableIdstringYesThe deliverable id.
    method"IN_APP" | "ESIGN" | "EMAIL" | "WET_INK" | "IMPLICIT_LAPSE" | "VERBAL_MINUTED"NoHow the sign-off is given.
    signatoryContactIdstringNoThe CRM contact id of the signatory.
    signatoryNamestringNoThe signatory name.
    signatoryEmailstring (email)NoThe signatory email address.
    dueAtstring (date-time)NoWhen the sign-off is due, as an ISO 8601 UTC date-time.
    lapseBusinessDaysintegerNoHow many business days without an answer before the sign-off lapses into deemed acceptance.
    statementstringNoThe statement the signatory signs.

    Create delivery engagements sources

    Changes data

    atlas_delivery_engagements_sources_create

    Add a source to an engagement: its title, kind, citation, dates, reliability, licence terms and whether it may be redistributed. Returns the created source.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/structuring/sources
    Example prompt
    Add the 2025 industry market report as a source.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    titlestringYesA short title, in one line.
    kind"CLIENT_DATA" | "PUBLIC_FILING" | "MARKET_REPORT" | "INTERVIEW" | "SURVEY" | "INTERNAL_BENCHMARK" | "EXPERT_NETWORK" | "VENDOR" | "ESTIMATE" | "ASSUMPTION"NoWhat kind of source it is.
    analysisIdstringNoThe id of the structuring analysis it relates to.
    citationstringNoThe full citation.
    urlstring (uri)NoThe source address.
    publishedOnstring (date-time)NoWhen the source was published, as an ISO 8601 date-time in UTC.
    accessedOnstring (date-time)NoWhen the source was accessed, as an ISO 8601 date-time in UTC.
    reliability"A" | "B" | "C" | "D" | "E" | "F"NoSource reliability, from A (completely reliable) to F (cannot be judged).
    informationCredibilityintegerNoInformation credibility, from 1 (confirmed) to 6 (cannot be judged).
    dataAsOfDatestring (date-time)NoThe date the data describes, as an ISO 8601 date-time in UTC.
    archivedCopyIdstringNoThe id of the attachment that holds an archived copy of the source.
    attributionTextRequiredstringNoThe attribution text the source licence requires.
    licenceTermsstringNoThe licence terms of the source.
    redistributablebooleanNoWhether the source may be redistributed to the client.
    attachmentIdstringNoThe id of an attachment already uploaded to Atlas.
    notesstringNoFree-text notes.

    List delivery engagements sources

    Read only

    atlas_delivery_engagements_sources_list

    List the sources on an engagement with their kind, reliability grade and credibility.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/structuring/sources
    Example prompt
    Which sources have we used and how reliable are they?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Rate delivery engagements sources

    Changes data

    atlas_delivery_engagements_sources_rate

    Grade a source on the reliability scale from A to F and the credibility scale from 1 to 6, and record a retraction when there is one. Returns the updated source.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/structuring/sources/{childId}/grade
    Example prompt
    Grade the market report B2.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    sourceIdstringYesThe source id.
    reliability"A" | "B" | "C" | "D" | "E" | "F"NoSource reliability, from A (completely reliable) to F (cannot be judged).
    informationCredibilityintegerNoInformation credibility, from 1 (confirmed) to 6 (cannot be judged).
    dataAsOfDatestring (date-time)NoThe date the data describes, as an ISO 8601 date-time in UTC.
    archivedCopyIdstringNoThe id of the attachment that holds an archived copy of the source.
    attributionTextRequiredstringNoThe attribution text the source licence requires.
    retractionFlagbooleanNoWhether the source has been retracted.

    Record delivery engagements sources triangulation

    Changes data

    atlas_delivery_engagements_sources_triangulation_record

    Record which other sources corroborate or contradict a source. Returns the updated source.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/structuring/sources/{childId}/triangulate
    Example prompt
    The survey corroborates the market report and the vendor figures contradict it.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    sourceIdstringYesThe source id.
    corroboratedByarray of stringNoThe ids of sources that corroborate this one.
    contradictedByarray of stringNoThe ids of sources that contradict this one.

    List delivery engagements staffing requests allocations

    Read only

    atlas_delivery_engagements_staffing_requests_allocations_list

    Read the effective allocation of every staffed person in a given engagement week, after their ramp profile is applied.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/staffing-requests/ramped-allocations
    Example prompt
    What is the effective team capacity in week 3?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    weekintegerYesThe engagement week, counting from 1.

    Create delivery engagements staffing requests

    Changes data

    atlas_delivery_engagements_staffing_requests_create

    Raise a staffing request for a role on an engagement: its grade, skills, allocation, needed-by date, whether it is key personnel, and whether the client must approve the person. Returns the request.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/staffing-requests
    Example prompt
    Raise a request for a senior data engineer at 100 percent from 1 March.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    roleGradestringYesThe grade needed, such as Senior Consultant.
    role"ENGAGEMENT_PARTNER" | "ENGAGEMENT_MANAGER" | "QA_REVIEWER" | "INDEPENDENT_REVIEWER" | "ENGAGEMENT_QUALITY_REVIEWER" | "WORKSTREAM_LEAD" | "CONSULTANT" | "ANALYST" | "SPECIALIST" | "PMO" | "CLIENT_SPONSOR" | "CLIENT_LEAD" | "CLIENT_SME" | "CLIENT_PMO" | "SUBCONTRACTOR" | "OBSERVER"YesThe engagement role to fill.
    skillsarray of stringNoThe skills needed.
    allocationPercentintegerNoThe allocation as a percentage of full time.
    mustHavestringNoWhat the person must have.
    niceToHavestringNoWhat would help.
    neededBystringNoWhen the person is needed by, as an ISO 8601 date.
    isKeyPersonnelbooleanNoWhether the role is named key personnel under the contract.
    clientApprovalRequiredbooleanNoWhether the client must approve the person.
    rateGradestringNoThe rate card grade the role is billed at.
    rampProfileIdstringNoThe id of a ramp profile to apply to the person who fills the request.

    List delivery engagements staffing requests

    Read only

    atlas_delivery_engagements_staffing_requests_list

    List the staffing requests of an engagement: role, grade, skills, allocation, needed-by date, proposed person and status.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/staffing-requests
    Example prompt
    Which roles on this engagement are still unfilled?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Recommend delivery engagements staffing requests

    Changes data

    atlas_delivery_engagements_staffing_requests_recommend

    Propose a person for a staffing request. Returns the updated request.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/staffing-requests/{requestId}/propose
    Example prompt
    Propose Priya for the data engineer role.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    requestIdstringYesThe staffing request id.
    userIdstringYesThe Atlas user id of the person proposed.

    List delivery engagements stakeholder interactions

    Read only

    atlas_delivery_engagements_stakeholder_interactions_list

    List the recorded contacts with one stakeholder, newest first. Use this to answer "when did we last speak to them".

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/stakeholders/{childId}/interactions
    Example prompt
    When did we last speak to the Northwind finance director?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    stakeholderIdstringYesThe stakeholder id.

    Log delivery engagements stakeholder interactions

    Changes data

    atlas_delivery_engagements_stakeholder_interactions_log

    Record a contact with a stakeholder: the channel, subject, summary and how they felt afterwards. Returns the recorded contact.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/stakeholders/{childId}/interactions
    Example prompt
    Log today's call with the Northwind sponsor: she is supportive of the new plan.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    stakeholderIdstringYesThe stakeholder id.
    channelstringYesHow the contact happened, for example email or call.
    subjectstringYesWhat the contact was about.
    summarystringNoWhat was said.
    occurredAtstring (date-time)NoWhen the contact happened, as an ISO 8601 UTC date-time. Defaults to now.
    sentimentAfter"CHAMPION" | "SUPPORTIVE" | "NEUTRAL" | "SCEPTICAL" | "OPPOSED"NoHow the stakeholder felt after the contact.
    durationMinintegerNoThe length in minutes.

    List delivery engagements stakeholders

    Read only

    atlas_delivery_engagements_stakeholders_list

    Read the stakeholder map of one engagement: who matters on the client side, how they feel about the work, and who is overdue a conversation.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/stakeholders
    Example prompt
    Who are we overdue a conversation with?

    Arguments

    FieldTypeRequiredDescription
    idstringYesThe engagement id.

    Set delivery engagements stakeholders

    Changes data

    atlas_delivery_engagements_stakeholders_set

    Add a stakeholder to an engagement, or update the one already recorded for the same person: their power, interest, sentiment and how they are managed. Returns the stakeholder.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/stakeholders
    Example prompt
    Add the Northwind finance director as a sceptical, high-power stakeholder.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    partyType"USER" | "CLIENT_CONTACT" | "EXTERNAL"YesWho the party is: a member, a client contact, or an external party.
    partyUserIdstringNoThe member id, when the party is a member.
    partyContactIdstringNoThe CRM contact id, when the party is a client contact.
    partyLabelstringNoThe party name, when the party is external.
    partyEmailstring (email)NoThe party email address, when the party is external.
    orgNamestringNoThe organisation the stakeholder belongs to.
    titlestringNoThe stakeholder job title.
    powerintegerNoHow much power the stakeholder has over the work, 1 to 5.
    interestintegerNoHow interested the stakeholder is, 1 to 5.
    influenceintegerNoHow much influence the stakeholder has, 1 to 5.
    supportLevelintegerNoHow much the stakeholder supports the work, from -2 to 2.
    sentiment"CHAMPION" | "SUPPORTIVE" | "NEUTRAL" | "SCEPTICAL" | "OPPOSED"NoHow the stakeholder feels about the work.
    strategy"MANAGE_CLOSELY" | "KEEP_SATISFIED" | "KEEP_INFORMED" | "MONITOR"NoHow the stakeholder is managed.
    strategyNotestringNoThe detail of the approach to the stakeholder.
    keyInterestsstringNoWhat the stakeholder cares about.
    concernsstringNoWhat worries the stakeholder.
    contactCadenceDaysintegerNoHow often, in days, the stakeholder should be contacted.
    relationshipOwnerUserIdstringNoThe member id who owns the relationship.
    isDecisionMakerbooleanNoWhether the stakeholder takes decisions.
    isSignatorybooleanNoWhether the stakeholder signs on behalf of the client.
    isEscalationPointbooleanNoWhether issues are escalated to this stakeholder.
    isBudgetHolderbooleanNoWhether the stakeholder holds the budget.
    isBlockerbooleanNoWhether the stakeholder is blocking the work.

    Add delivery engagements status report recipients

    Changes data

    atlas_delivery_engagements_status_report_recipients_add

    Add a recipient to a status report, as a member, a client contact or an external party, with the channel and format. Returns the recipient.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/status-reports/{childId}/recipients
    Example prompt
    Add the Northwind CFO to the status report recipients by email.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    reportIdstringYesThe status report id.
    partyType"USER" | "CLIENT_CONTACT" | "EXTERNAL"NoWho the party is: a member, a client contact, or an external party.
    partyUserIdstringNoThe member id, when the party is a member.
    partyContactIdstringNoThe CRM contact id, when the party is a client contact.
    partyLabelstringNoThe party name, when the party is external.
    partyEmailstring (email)NoThe party email address, when the party is external.
    channel"EMAIL" | "PORTAL" | "IN_APP" | "MEETING" | "OTHER"NoHow the report is sent.
    format"PDF" | "HTML" | "DOCX" | "LINK"NoThe format the report is sent in.

    List delivery engagements status report recipients

    Read only

    atlas_delivery_engagements_status_report_recipients_list

    List who a status report is sent to, with the channel and format for each.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/status-reports/{childId}/recipients
    Example prompt
    Who receives the Northwind status report?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    reportIdstringYesThe status report id.

    Create delivery engagements status report revisions

    Changes data

    atlas_delivery_engagements_status_report_revisions_create

    Revise an issued status report: the issued one is marked superseded and a new draft for the same period is created from the engagement as it stands. Returns the new draft.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/status-reports/{childId}/supersede
    Example prompt
    Start a corrected version of last week's issued report.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    reportIdstringYesThe status report id.

    Create delivery engagements status report sections

    Changes data

    atlas_delivery_engagements_status_report_sections_create

    Add a section to a draft status report, for example a workstream update or a budget section. Returns the section.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/status-reports/{childId}/sections
    Example prompt
    Add a data migration workstream section to the draft report.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    reportIdstringYesThe status report id.
    kind"WORKSTREAM" | "PHASE" | "NARRATIVE" | "RAID" | "BUDGET" | "MILESTONES" | "DECISIONS" | "ASKS" | "APPENDIX"YesWhat the section covers.
    titlestringYesThe section title.
    positionintegerNoWhere it sits in the list, from 0.
    workstreamIdstringNoThe workstream id.
    phaseIdstringNoThe phase id.
    rag"GREEN" | "AMBER" | "RED" | "GREY"NoThe traffic light.
    percentCompleteintegerNoHow complete it is, 0 to 100.
    bodystringNoThe section text.
    ownerUserIdstringNoThe member id who writes the section.
    audience"INTERNAL" | "CLIENT"NoWho the record is written for: the firm only, or the client.

    Delete delivery engagements status report sections

    Destructive

    atlas_delivery_engagements_status_report_sections_delete

    Remove a section from a draft status report. A section of an issued report cannot be removed.

    Scope
    delivery:write
    Calls
    DELETE /v1/engagements/{engagementId}/status-reports/{childId}/sections/{sectionId}
    Example prompt
    Remove the appendix section from the draft report.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    reportIdstringYesThe status report id.
    sectionIdstringYesThe section id.

    List delivery engagements status report sections

    Read only

    atlas_delivery_engagements_status_report_sections_list

    List the sections of a status report in order, with each section's traffic light, progress, owner and text.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/status-reports/{childId}/sections
    Example prompt
    What sections are in this week's status report?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    reportIdstringYesThe status report id.

    Update delivery engagements status report sections

    Changes data

    atlas_delivery_engagements_status_report_sections_update

    Edit a section of a draft status report. Send only the fields that change. Returns the section.

    Scope
    delivery:write
    Calls
    PATCH /v1/engagements/{engagementId}/status-reports/{childId}/sections/{sectionId}
    Example prompt
    Change the data migration section light to amber.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    reportIdstringYesThe status report id.
    sectionIdstringYesThe section id.
    titlestringNoThe section title.
    positionintegerNoWhere it sits in the list, from 0.
    rag"GREEN" | "AMBER" | "RED" | "GREY"NoThe traffic light.
    percentCompleteintegerNoHow complete it is, 0 to 100.
    bodystringNoThe section text.
    ownerUserIdstring | nullNoThe member id who writes the section.
    audience"INTERNAL" | "CLIENT"NoWho the record is written for: the firm only, or the client.

    Create delivery engagements status reports

    Changes data

    atlas_delivery_engagements_status_reports_create

    Start a blank status report for a period. Returns the draft.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/status-reports
    Example prompt
    Start a blank status report for this week.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    titlestringNoThe report title.
    periodStartstring (date-time)NoThe start of the reporting period, as an ISO 8601 UTC date-time.
    periodEndstring (date-time)NoThe end of the reporting period, as an ISO 8601 UTC date-time.
    audience"INTERNAL" | "CLIENT"NoWho the record is written for: the firm only, or the client.
    confidentialbooleanNoWhether the report is confidential.

    Delete delivery engagements status reports

    Destructive

    atlas_delivery_engagements_status_reports_delete

    Delete a status report that has not been issued. An issued report is refused, because the client holds it; revise it instead.

    Scope
    delivery:write
    Calls
    DELETE /v1/engagements/{engagementId}/status-reports/{childId}
    Example prompt
    Delete the draft status report I started by mistake.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    reportIdstringYesThe status report id.

    Generate delivery engagements status reports

    Changes data

    atlas_delivery_engagements_status_reports_generate

    Start a status report for a period, pre-filled from the engagement: traffic lights, progress, RAID highlights and milestones. Returns the draft for a person to edit.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/status-reports/generate-draft
    Example prompt
    Draft this week's Northwind status report from the engagement.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    titlestringNoThe report title.
    periodStartstring (date-time)NoThe start of the reporting period, as an ISO 8601 UTC date-time.
    periodEndstring (date-time)NoThe end of the reporting period, as an ISO 8601 UTC date-time.
    audience"INTERNAL" | "CLIENT"NoWho the record is written for: the firm only, or the client.
    confidentialbooleanNoWhether the report is confidential.

    Get delivery engagements status reports

    Read only

    atlas_delivery_engagements_status_reports_get

    Read one status report in full: its period, traffic lights, narrative, sections and state.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/status-reports/{childId}
    Example prompt
    Show me last week's Northwind status report.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    reportIdstringYesThe status report id.

    List delivery engagements status reports

    Read only

    atlas_delivery_engagements_status_reports_list

    Read the status report history for one engagement, with each report period, the seven health ratings and whether it was issued. Pass `nextCursor` back as `cursor` for the next page.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/status-reports
    Example prompt
    Show me the last status report for Northwind.

    Arguments

    FieldTypeRequiredDescription
    idstringYesThe engagement id.
    limitintegerNoPage size, 1 to 200.
    cursorstringNoThe nextCursor of the previous page. Leave it out for the first page.

    Refresh delivery engagements status reports

    Changes data

    atlas_delivery_engagements_status_reports_refresh

    Pull the latest figures onto a draft status report. Only the figures are refreshed; every word the author wrote is kept. Returns the report.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/status-reports/{childId}/refresh-snapshot
    Example prompt
    Refresh the figures on the draft status report.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    reportIdstringYesThe status report id.

    Revoke delivery engagements status reports share

    Destructive

    atlas_delivery_engagements_status_reports_share_revoke

    Take a status report back from the client, with the reason. The change is audited and recorded on the timeline.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/status-reports/{childId}/unshare
    Example prompt
    Take last week's status report back from the client.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    reportIdstringYesThe status report id.
    reasonstringYesWhy the report is taken back from the client.

    Get delivery engagements status reports since last

    Read only

    atlas_delivery_engagements_status_reports_since_last_get

    What has changed on the engagement since the last issued status report: traffic light moves, new risks, completed work and slipped dates. Use this when writing the next report.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/status-reports/since-last
    Example prompt
    What has changed since the last status report?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Submit delivery engagements status reports

    Changes data

    atlas_delivery_engagements_status_reports_submit

    Submit a draft status report for approval. Returns the report in its new state.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/status-reports/{childId}/submit
    Example prompt
    Submit the draft status report for approval.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    reportIdstringYesThe status report id.

    Update delivery engagements status reports

    Changes data

    atlas_delivery_engagements_status_reports_update

    Edit a draft status report: its traffic lights, summary, accomplishments, next period, asks of the client and decisions needed. Send only the fields that change. Returns the report.

    Scope
    delivery:write
    Calls
    PATCH /v1/engagements/{engagementId}/status-reports/{childId}
    Example prompt
    Set the executive summary of the draft report to this paragraph.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    reportIdstringYesThe status report id.
    titlestringNoThe report title.
    overallRag"GREEN" | "AMBER" | "RED" | "GREY"NoThe overall traffic light.
    scheduleRag"GREEN" | "AMBER" | "RED" | "GREY"NoThe schedule traffic light.
    budgetRag"GREEN" | "AMBER" | "RED" | "GREY"NoThe budget traffic light.
    scopeRag"GREEN" | "AMBER" | "RED" | "GREY"NoThe scope traffic light.
    qualityRag"GREEN" | "AMBER" | "RED" | "GREY"NoThe quality traffic light.
    resourceRag"GREEN" | "AMBER" | "RED" | "GREY"NoThe resourcing traffic light.
    clientRag"GREEN" | "AMBER" | "RED" | "GREY"NoThe client relationship traffic light.
    ragMovementNotestringNoWhy the traffic lights moved since the last report.
    executiveSummarystringNoThe executive summary.
    accomplishmentsstringNoWhat was achieved in the period.
    nextPeriodstringNoWhat is planned for the next period.
    asksOfClientstringNoWhat the firm needs from the client.
    decisionsNeededstringNoThe decisions the client needs to take.
    raidHighlightIdsarray of stringNoThe RAID item ids to highlight in the report.
    confidentialbooleanNoWhether the report is confidential.

    Get delivery engagements storyline

    Read only

    atlas_delivery_engagements_storyline_get

    How far the deck actually is. Returns each section with its status and a progress summary counting evidenced pages rather than a completion percentage: a page counts as evidenced only when it has an answer written on it and a completed analysis behind it.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/structuring/storyline
    Example prompt
    What is the storyline for the Northwind deck?

    Arguments

    FieldTypeRequiredDescription
    idstringYesThe engagement id.

    Create delivery engagements storyline sections

    Changes data

    atlas_delivery_engagements_storyline_sections_create

    Add a section to the storyline: a page title, governing thought, section type, and the analysis and deliverable behind it. Returns the created section.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/structuring/storyline
    Example prompt
    Add a storyline page: SME churn is the biggest value lever.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    pageTitlestringNoThe page title, written as the answer the page gives.
    governingThoughtstringNoThe single message of the page.
    sectionType"SITUATION" | "COMPLICATION" | "QUESTION" | "ANSWER" | "SUPPORT" | "EVIDENCE" | "RECOMMENDATION" | "NEXT_STEPS"NoThe role the section plays in the storyline.
    supportKind"DEDUCTIVE" | "INDUCTIVE"NoWhether the supporting points argue deductively or inductively.
    parentSectionIdstringNoThe id of the parent storyline section.
    deliverableIdstringNoThe id of the engagement deliverable.
    exhibitDescriptionstringNoWhat the exhibit on the page shows.
    analysisIdstringNoThe id of the structuring analysis it relates to.
    ownerUserIdstringNoThe Atlas user id of the person who owns it.
    notesstringNoFree-text notes.

    Reorder delivery engagements storyline sections

    Changes data

    atlas_delivery_engagements_storyline_sections_reorder

    Set the order of storyline sections under one parent, by sending every section id first to last. Returns the sections in their new order.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/structuring/storyline/reorder
    Example prompt
    Put the recommendation page before the next steps page.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    orderedIdsarray of stringYesEvery section id under the parent, first to last.
    parentIdstring | nullNoThe id of the parent section whose children are reordered, or null for the top level.

    Update delivery engagements storyline sections

    Changes data

    atlas_delivery_engagements_storyline_sections_update

    Change a storyline section, including its status between ghost, draft and final. Only the fields sent change. Returns the updated section.

    Scope
    delivery:write
    Calls
    PATCH /v1/engagements/{engagementId}/structuring/storyline/{childId}
    Example prompt
    Move the churn page to draft.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    sectionIdstringYesThe storyline section id.
    pageTitlestringNoThe page title, written as the answer the page gives.
    governingThoughtstringNoThe single message of the page.
    sectionType"SITUATION" | "COMPLICATION" | "QUESTION" | "ANSWER" | "SUPPORT" | "EVIDENCE" | "RECOMMENDATION" | "NEXT_STEPS"NoThe role the section plays in the storyline.
    supportKind"DEDUCTIVE" | "INDUCTIVE"NoWhether the supporting points argue deductively or inductively.
    parentSectionIdstringNoThe id of the parent storyline section.
    deliverableIdstringNoThe id of the engagement deliverable.
    exhibitDescriptionstringNoWhat the exhibit on the page shows.
    analysisIdstringNoThe id of the structuring analysis it relates to.
    ownerUserIdstringNoThe Atlas user id of the person who owns it.
    notesstringNoFree-text notes.
    status"GHOST" | "DRAFT" | "FINAL"NoThe drafting state of the page.

    Verify delivery engagements storyline sections

    Changes data

    atlas_delivery_engagements_storyline_sections_verify

    Mark a storyline section as evidenced. The API refuses unless the page has a governing thought and a completed analysis behind it, and names what is missing. Returns the updated section.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/structuring/storyline/{childId}/evidence
    Example prompt
    Mark the churn page as evidenced.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    sectionIdstringYesThe storyline section id.

    List delivery engagements subcontractors

    Read only

    atlas_delivery_engagements_subcontractors_list

    Read the subcontractor register of one engagement: each party with its role, workstream, contract status, rates, dates, and whether insurance, the confidentiality agreement and the flow-down clauses are in place. Use this to answer "who is working on this engagement who is not ours".

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/subcontractors
    Example prompt
    Which subcontractors on Northwind have no executed contract?

    Arguments

    FieldTypeRequiredDescription
    idstringYesThe engagement id.

    Get delivery engagements summary

    Read only

    atlas_delivery_engagements_summary_get

    Count the engagements in the workspace: the total, the count in each lifecycle state, and how many are at risk. Use this to answer "how many engagements are active" without listing them.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/summary
    Example prompt
    How many engagements are active, and how many are at risk?

    Arguments

    This tool takes no arguments.

    Get delivery engagements tax profile

    Read only

    atlas_delivery_engagements_tax_profile_get

    Read the tax position of an engagement: the entities and tax residences, place of supply, VAT treatment, e-invoicing mandate, withholding tax and treaty rates, gross-up, certificates required and transfer pricing arrangement.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/tax-profile
    Example prompt
    What is the withholding tax position on the Northwind engagement?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Set delivery engagements tax profile

    Changes data

    atlas_delivery_engagements_tax_profile_set

    Save the tax position of an engagement. Only the fields sent change; the rest keep their values. Rates are decimal strings. Returns the tax profile.

    Scope
    delivery:write
    Calls
    PUT /v1/engagements/{engagementId}/tax-profile
    Example prompt
    Set the treaty withholding rate on Northwind to 5 percent and note a gross-up clause.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    ourEntitystringNoThe firm entity that contracts.
    ourTaxResidencestringNoThe two-letter country code of the firm entity tax residence.
    clientEntitystringNoThe client entity that contracts.
    clientTaxResidencestringNoThe two-letter country code of the client tax residence.
    placeOfSupplyBasisstringNoThe basis of the place of supply.
    vatTreatmentstringNoThe VAT treatment, such as REVERSE_CHARGE.
    vatRegistrationRequiredInClientCountrybooleanNoWhether the firm must register for VAT in the client country.
    eInvoicingMandatestringNoThe e-invoicing mandate that applies.
    withholdingTaxApplicablebooleanNoWhether withholding tax applies to the fees.
    whtRateDomesticstringNoThe domestic withholding tax rate, as a decimal string.
    treatyRatestringNoThe treaty withholding tax rate, as a decimal string.
    treatyReliefFormRequiredstringNoThe treaty relief form required, if any.
    grossUpClausePresentbooleanNoWhether the contract has a gross-up clause, so the client bears the withholding.
    whtCertificateRequiredFromClientbooleanNoWhether a withholding tax certificate is needed from the client.
    whtCreditRecoverablebooleanNoWhether the withholding tax can be recovered as a credit.
    socialSecurityCertificatesRequiredbooleanNoWhether social security certificates are needed for the team.
    shortTermBusinessVisitorAgreementbooleanNoWhether a short-term business visitor agreement is in place.
    salesTaxNexusStatesarray of stringNoThe states where the work creates sales tax nexus.
    transferPricingArrangementstringNoThe transfer pricing arrangement.

    Add delivery engagements team members

    Changes data

    atlas_delivery_engagements_team_members_add

    Add a person to the team of an engagement, as a member, a client contact or an external party, with their role and allocation. Returns the new team entry.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/team
    Example prompt
    Add Sam to the Northwind team as a consultant at fifty percent.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    side"FIRM" | "CLIENT" | "THIRD_PARTY"YesWhich side the person is on.
    role"ENGAGEMENT_PARTNER" | "ENGAGEMENT_MANAGER" | "QA_REVIEWER" | "INDEPENDENT_REVIEWER" | "ENGAGEMENT_QUALITY_REVIEWER" | "WORKSTREAM_LEAD" | "CONSULTANT" | "ANALYST" | "SPECIALIST" | "PMO" | "CLIENT_SPONSOR" | "CLIENT_LEAD" | "CLIENT_SME" | "CLIENT_PMO" | "SUBCONTRACTOR" | "OBSERVER"YesThe role the person plays on the engagement.
    partyType"USER" | "CLIENT_CONTACT" | "EXTERNAL"YesWho the party is: a member, a client contact, or an external party.
    partyUserIdstringNoThe member id, when the party is a member.
    partyContactIdstringNoThe CRM contact id, when the party is a client contact.
    partyLabelstringNoThe party name, when the party is external.
    partyEmailstring (email)NoThe party email address, when the party is external.
    workstreamIdstringNoThe workstream the person works on.
    allocationPercentintegerNoHow much of the person's time the engagement takes, 0 to 100.
    isKeyPersonnelbooleanNoWhether the contract names this person as key personnel.
    shareEmailWithClientbooleanNoWhether the client can see the email address.

    List delivery engagements team members

    Read only

    atlas_delivery_engagements_team_members_list

    List the team of one engagement on every side: the firm, the client and third parties, with roles, allocation and key personnel. Use this to answer "who is on this engagement".

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/team
    Example prompt
    Who is on the Northwind engagement team?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Apply delivery engagements templates

    Destructive

    atlas_delivery_engagements_templates_apply

    Copy a playbook into an engagement: its phases, workstreams, deliverables, responsibility matrix, starter risks, meetings, information requests, closure items, report sections and checks. It writes across nine registers at once and cannot be undone, so confirm the playbook with the person first. Returns what was created.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/apply-template
    Example prompt
    Apply the due diligence playbook to the new Fabrikam engagement.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    slugstringYesThe playbook slug, as the template list returns it.

    List delivery engagements third party reliance

    Read only

    atlas_delivery_engagements_third_party_reliance_list

    List the work of other specialists the engagement relies on: each specialist, the assessments of their competence and objectivity, the firm evaluation of their work, and whether reliance on it has been accepted.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/third-party-reliance
    Example prompt
    Which specialists are we relying on for the Northwind audit?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Record delivery engagements third party reliance

    Changes data

    atlas_delivery_engagements_third_party_reliance_record

    Record work by another specialist that the engagement intends to rely on, with the assessments and evaluation drafted for it. The record is unaccepted; accepting reliance on it stays with a person. Returns the record.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/third-party-reliance
    Example prompt
    Record the property valuer report we intend to rely on, with our draft evaluation.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    specialistTypestringYesThe kind of specialist, such as VALUER or ACTUARY.
    specialistIdentitystringYesWho the specialist is.
    competenceAssessmentstringNoThe assessment of their competence.
    objectivityAssessmentstringNoThe assessment of their objectivity.
    scopeOfTheirWorkstringNoWhat their work covers.
    ourEvaluationOfTheirWorkstringNoThe firm evaluation of their work, which accepting reliance requires.
    assumptionsTheyReliedOnstringNoThe assumptions their work rests on.
    limitationsstringNoThe limitations of their work.
    theirLiabilityPositionstringNoTheir liability position.
    disclosureInOurReportbooleanNoWhether the firm report discloses the reliance.
    theirConsentToReferencebooleanNoWhether they consent to being referred to.
    theirReportIdstringNoThe id of their report as held in Atlas.
    datedstring (date-time)NoThe date of their work, as an ISO 8601 date-time in UTC.

    Answer delivery engagements threads

    Changes data

    atlas_delivery_engagements_threads_answer

    Record the answer to a thread, with a summary. Returns the updated thread.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/threads/{childId}/answer
    Example prompt
    Record the answer: VPN access will be ready on Thursday.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    threadIdstringYesThe thread id.
    answerSummarystringYesThe answer, summarised.

    Close delivery engagements threads

    Changes data

    atlas_delivery_engagements_threads_close

    Close a thread, with the reason, whether or not it was answered. Returns the updated thread.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/threads/{childId}/close
    Example prompt
    Close the VPN thread, access is working.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    threadIdstringYesThe thread id.
    closeReasonstringYesWhy the thread is closed.

    Create delivery engagements threads

    Changes data

    atlas_delivery_engagements_threads_create

    Open a thread on an engagement: a question, clarification, request, blocker, review comment, escalation or complaint, asked of a named party, with a response time. Returns the created thread.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/threads
    Example prompt
    Ask the client IT lead whether we can get VPN access by Friday.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    titlestringYesA short title, in one line.
    bodystringNoThe question or message in full.
    kind"QUESTION" | "CLARIFICATION" | "INFORMATION_REQUEST" | "DATA_REQUEST" | "BLOCKER" | "REVIEW_COMMENT" | "ESCALATION" | "COMPLAINT"NoWhat kind of thread it is.
    severity"LOW" | "MEDIUM" | "HIGH" | "CRITICAL"NoHow severe it is.
    subjectType"PHASE" | "WORKSTREAM" | "OBJECTIVE" | "SCOPE_STATEMENT" | "DELIVERABLE" | "PLAN_ITEM" | "RAID_ITEM" | "MEETING" | "MEETING_SERIES" | "THREAD" | "INFO_REQUEST" | "CHANGE_REQUEST" | "STATUS_REPORT" | "STAKEHOLDER" | "BILLING_MILESTONE" | "SIGN_OFF" | "CHECK" | "LEGAL_INSTRUMENT" | "CLOSURE_ITEM" | "BENEFIT" | "ACCESS_PROVISION" | "COMMERCIAL_TERM" | "ANALYTICAL_ASSUMPTION" | "RESPONSIBILITY_AREA" | "FOLLOW_UP" | "CLIENT_PROCUREMENT" | "ENGAGEMENT"NoThe kind of engagement record it is about.
    subjectIdstringNoThe id of the engagement record it is about.
    subjectLabelstringNoA readable label for the record it is about.
    workstreamIdstringNoThe id of the engagement workstream it belongs to.
    askedOfPartyType"USER" | "CLIENT_CONTACT" | "EXTERNAL"NoWho the question is asked of: an Atlas user, a client contact, or an external person.
    askedOfUserIdstringNoThe Atlas user id of the person asked, when that person is a user.
    askedOfContactIdstringNoThe CRM contact id of the person asked, when that person is a client contact.
    askedOfLabelstringNoA display name for the person asked, when there is no user or contact record.
    ownerUserIdstringNoThe Atlas user id of the person who owns it.
    slaHoursintegerNoHow many hours the asked party has to respond.

    Record delivery engagements threads first response

    Changes data

    atlas_delivery_engagements_threads_first_response_record

    Record the first response on a thread, which stops its first-response clock. Returns the updated thread.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/threads/{childId}/respond
    Example prompt
    Record that we have responded to the client question on scope.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    threadIdstringYesThe thread id.

    List delivery engagements threads

    Read only

    atlas_delivery_engagements_threads_list

    Read the open questions, blockers and escalations on one engagement, including which side each is waiting on. Use this to answer "what is unanswered". Pass `nextCursor` back as `cursor` for the next page.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/threads
    Example prompt
    What questions are unanswered on Northwind?

    Arguments

    FieldTypeRequiredDescription
    idstringYesThe engagement id.
    limitintegerNoPage size, 1 to 200.
    cursorstringNoThe nextCursor of the previous page. Leave it out for the first page.

    Reopen delivery engagements threads

    Changes data

    atlas_delivery_engagements_threads_reopen

    Reopen a closed or answered thread, so its response clock runs again. Returns the updated thread.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/threads/{childId}/reopen
    Example prompt
    Reopen the VPN thread, access has broken again.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    threadIdstringYesThe thread id.

    List delivery engagements timeline

    Read only

    atlas_delivery_engagements_timeline_list

    Read the timeline of one engagement: every recorded event, newest first, with its kind and source. Use this to answer "what happened on this engagement" or "what changed this week".

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/timeline
    Example prompt
    What happened on the Northwind engagement this week?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    kindstringNoFilter to one event kind.
    sourcestringNoFilter to one event source.
    limitintegerNoPage size (1..200).
    cursorstringNoThe cursor from the previous page, to read the next one.

    Transition delivery engagements

    Changes data

    atlas_delivery_engagements_transition

    Move an engagement to another lifecycle state, for example from mobilising to active or from active to on hold. It cannot close, terminate or cancel an engagement: ending an engagement belongs to a person, so those states are refused. The API also refuses a move the lifecycle does not allow and says why. Returns the engagement in its new state.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{id}/transition
    Example prompt
    Put the Northwind engagement on hold while the client reorganises.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    to"PIPELINE" | "ACCEPTANCE" | "MOBILISING" | "ACTIVE" | "ON_HOLD" | "IN_CLOSURE" | "HYPERCARE"YesThe state to move to. Closed, terminated and cancelled are not offered.
    reasonstringNoWhy the engagement is moving, recorded on the timeline.

    Get delivery engagements transition plan

    Read only

    atlas_delivery_engagements_transition_plan_get

    Read the transition plan of an engagement: who takes over, hypercare and warranty windows, support model, knowledge transfer, residual risks, staff transfer obligations and the rollback plan.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/transition-plan
    Example prompt
    When does hypercare end on this engagement?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Set delivery engagements transition plan

    Changes data

    atlas_delivery_engagements_transition_plan_set

    Write the transition plan of an engagement. The receiving team is required; every other field is optional. Returns the plan.

    Scope
    delivery:write
    Calls
    PUT /v1/engagements/{engagementId}/transition-plan
    Example prompt
    Set the transition plan: the client service desk takes over with four weeks of hypercare.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    targetTeamstringYesThe team that takes over the service.
    targetOwnerContactIdstringNoThe CRM contact id of the client-side owner taking over the service.
    hypercareFromstringNoWhen hypercare starts, as an ISO 8601 date.
    hypercareTostringNoWhen hypercare ends, as an ISO 8601 date.
    warrantyFromstringNoWhen the warranty period starts, as an ISO 8601 date.
    warrantyTostringNoWhen the warranty period ends, as an ISO 8601 date.
    supportModelstringNoHow the service is supported after transition.
    knowledgeTransferSessionsintegerNoHow many knowledge transfer sessions are planned.
    residualRisksstringNoThe risks that remain after transition.
    openDefectsintegerNoHow many defects are open at handover.
    staffTransferApplicablebooleanNoWhether staff transfer with the service.
    employeeLiabilityInformationDueAtstringNoWhen employee liability information is due, as an ISO 8601 date.
    worksCouncilConsultationCompletedAtstringNoWhen works council consultation was completed, as an ISO 8601 date.
    pensionAndBenefitsObligationsstringNoPension and benefit obligations that transfer with staff.
    contractsNovatedanyNoThe contracts novated to the client, in whatever structure the team records.
    parallelRunPeriodDaysintegerNoHow many days the old and new run in parallel.
    serviceCreditsStartAtstringNoWhen service credits start to apply, as an ISO 8601 date.
    rollbackPlanstringNoHow to roll back if the transition fails.

    Update delivery engagements

    Changes data

    atlas_delivery_engagements_update

    Change the details of an engagement: its name, summary, type, fee model, values, dates, leadership and confidentiality. Send only the fields that change. Returns the updated engagement. The lifecycle state and the traffic lights have their own tools.

    Scope
    delivery:write
    Calls
    PATCH /v1/engagements/{id}
    Example prompt
    Move the end date of the Northwind engagement to the end of March.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    namestringNoThe engagement name.
    summarystring | nullNoA short summary of the work, or null to clear it.
    type"ADVISORY" | "IMPLEMENTATION" | "MANAGED_SERVICE" | "AUDIT" | "RETAINER" | "DUE_DILIGENCE" | "TRANSFORMATION" | "STAFF_AUGMENTATION" | "TRAINING" | "RESEARCH" | "INTERIM_MANAGEMENT"NoWhat kind of engagement this is.
    feeModel"FIXED" | "TIME_AND_MATERIALS" | "CAPPED_TM" | "RETAINER" | "MILESTONE" | "OUTCOME" | "RISK_REWARD" | "GAIN_SHARE" | "SUBSCRIPTION" | "BLENDED" | "NOT_TO_EXCEED" | "PRO_BONO"NoHow the engagement is charged.
    currencystringNoThe ISO 4217 currency code, for example USD.
    contractValuestring | nullNoThe contract value, as a decimal string, or null to clear it.
    ceilingValuestring | nullNoThe fee ceiling, as a decimal string, or null to clear it.
    notToExceedValuestring | nullNoThe not-to-exceed value, as a decimal string, or null to clear it.
    startsOnstring (date-time) | nullNoWhen the engagement starts, as an ISO 8601 UTC date-time, or null to clear it.
    endsOnstring (date-time) | nullNoWhen the engagement ends, as an ISO 8601 UTC date-time, or null to clear it.
    partnerUserIdstring | nullNoThe member id of the engagement partner, or null to clear it.
    managerUserIdstring | nullNoThe member id of the engagement manager, or null to clear it.
    qaReviewerUserIdstring | nullNoThe member id of the quality reviewer, or null to clear it.
    deliveryModelstring | nullNoHow the work is delivered, for example ONSITE or REMOTE, or null to clear it.
    confidentiality"STANDARD" | "RESTRICTED" | "HIGHLY_RESTRICTED"NoHow widely the engagement may be seen inside the firm.
    restrictedAccessOnlybooleanNoWhether only named people may see the engagement.

    Get delivery engagements ways of working

    Read only

    atlas_delivery_engagements_ways_of_working_get

    Read the ways-of-working charter of an engagement: working hours, meeting cadence, channels, response times, conventions, definitions of done and ready, and whether the client has agreed it.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/ways-of-working
    Example prompt
    What did we agree with the client about response times?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Set delivery engagements ways of working

    Changes data

    atlas_delivery_engagements_ways_of_working_set

    Write the ways-of-working charter of an engagement. Only the fields sent change. Returns the charter.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/ways-of-working
    Example prompt
    Record that core hours are 10 to 4 UK time and responses are due within one working day.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    workingHoursstringNoThe agreed working hours.
    coreHoursstringNoThe core hours everyone is available.
    timezonesTextstringNoThe time zones the team works across.
    meetingCadenceTextstringNoThe agreed meeting cadence.
    communicationChannelsstringNoThe channels used for which kind of communication.
    responseSlaTextstringNoThe agreed response times.
    escalationTextstringNoHow escalation works, in words.
    documentConventionsstringNoThe document conventions.
    namingConventionstringNoThe file naming convention.
    versioningConventionstringNoThe versioning convention.
    definitionOfDonestringNoThe definition of done.
    definitionOfReadystringNoThe definition of ready.
    decisionProtocolstringNoHow decisions are taken and recorded.
    confidentialityProtocolstringNoHow confidential material is handled.
    toolingTextstringNoThe tools the team uses.
    riskAppetiteStatementstringNoThe risk appetite agreed with the client.
    clientVisiblebooleanNoWhether the client can see the charter.
    agreedbooleanNoWhether the client has agreed the charter.

    Create delivery engagements working paper file

    Changes data

    atlas_delivery_engagements_working_paper_file_create

    Open the working paper file of an engagement under an assembly standard, with its structure template, report date, retention period and storage jurisdiction. Returns the file.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/working-papers
    Example prompt
    Open the working paper file under ISA 230 with seven years retention.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    assemblyStandard"ISA_230" | "PCAOB_AS_1215" | "FIRM_POLICY"NoThe standard the file is assembled under.
    structureTemplatestringNoThe template the file sections follow.
    reportDatestring (date-time)NoThe report date the file supports, as an ISO 8601 date-time in UTC.
    retentionPeriodYearsintegerNoHow many years the file is retained after the report date.
    storageJurisdictionstringNoThe two-letter country code where the file is stored.
    tickmarkLegendobjectNoThe tickmark legend: each tickmark and what it means.

    Get delivery engagements working paper file

    Read only

    atlas_delivery_engagements_working_paper_file_get

    Read the working paper file of an engagement: its assembly standard, report date, retention, lock state, legal holds and completeness.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/working-papers
    Example prompt
    Is the working paper file for this engagement locked?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Get delivery engagements working paper file readiness

    Read only

    atlas_delivery_engagements_working_paper_file_readiness_get

    Check whether the working paper file is ready to lock: papers not prepared or reviewed, review notes still open, and the assembly deadline. Returns the blockers; an empty list means it is ready.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/working-papers/readiness
    Example prompt
    What is stopping us from locking the working papers?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Update delivery engagements working paper file

    Changes data

    atlas_delivery_engagements_working_paper_file_update

    Change the settings of an unlocked working paper file, such as its report date, retention or completeness checklist status. Returns the updated file.

    Scope
    delivery:write
    Calls
    PATCH /v1/engagements/{engagementId}/working-papers
    Example prompt
    Set the report date on the working paper file to 31 March.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    assemblyStandard"ISA_230" | "PCAOB_AS_1215" | "FIRM_POLICY"NoThe standard the file is assembled under.
    structureTemplatestringNoThe template the file sections follow.
    reportDatestring (date-time)NoThe report date the file supports, as an ISO 8601 date-time in UTC.
    retentionPeriodYearsintegerNoHow many years the file is retained after the report date.
    storageJurisdictionstringNoThe two-letter country code where the file is stored.
    tickmarkLegendobjectNoThe tickmark legend: each tickmark and what it means.
    unresolvedMustFixCountintegerNoHow many must-fix review points are still open.

    Verify delivery engagements working paper file

    Read only

    atlas_delivery_engagements_working_paper_file_verify

    Verify the integrity of a locked working paper file against its recorded fingerprints. Returns whether every paper is unchanged since the lock, and which are not.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/working-papers/verify
    Example prompt
    Has anything in the locked file changed since it was locked?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Create delivery engagements working paper holds

    Changes data

    atlas_delivery_engagements_working_paper_holds_create

    Place a legal hold on the working paper file, with the reason. A held file cannot be destroyed. Returns the updated file.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/working-papers/hold
    Example prompt
    Put a legal hold on the working papers because of the regulator enquiry.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    reasonstringYesWhy the hold is placed, such as the matter or enquiry it preserves evidence for.

    Create delivery engagements working papers

    Changes data

    atlas_delivery_engagements_working_papers_create

    Add a paper to the working paper file under a section, with its purpose, index reference, attachment and cross-references. Adding to a locked file needs a reason and an approver. Returns the created paper.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/working-papers/papers
    Example prompt
    Add the revenue testing paper under section C.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    sectionstringYesThe file section the paper belongs to, such as C.
    titlestringYesA short title, in one line.
    purposestringNoWhat it is for.
    indexRefstringNoThe index reference of the paper within its section.
    attachmentIdstringNoThe id of an attachment already uploaded to Atlas.
    crossReferencesarray of stringNoIndex references of related papers.

    List delivery engagements working papers

    Read only

    atlas_delivery_engagements_working_papers_list

    List the papers in the working paper file with their section, index reference, preparer and reviewer sign-offs.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/working-papers/papers
    Example prompt
    Which working papers are still unreviewed?

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.

    Create delivery engagements workstreams

    Changes data

    atlas_delivery_engagements_workstreams_create

    Add a workstream to an engagement, with its lead. Returns the new workstream.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/{engagementId}/workstreams
    Example prompt
    Add a data migration workstream led by Priya.

    Arguments

    FieldTypeRequiredDescription
    engagementIdstringYesThe engagement id.
    keystringYesA short key, unique within the engagement.
    namestringYesThe workstream name.
    descriptionstringNoWhat the workstream covers.
    positionintegerNoWhere it sits in the list, from 0.
    leadUserIdstringNoThe member id of the workstream lead.
    colourstringNoA display colour as a hex code, for example #4F46E5.

    List delivery engagements workstreams

    Read only

    atlas_delivery_engagements_workstreams_list

    Read the workstreams of one engagement, each with its own traffic light and progress. Use this to answer "which part of the work is in trouble" rather than judging the engagement as a whole.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/{engagementId}/workstreams
    Example prompt
    Which workstream is in trouble?

    Arguments

    FieldTypeRequiredDescription
    idstringYesThe engagement id.

    List delivery my engagements

    Read only

    atlas_delivery_my_engagements_list

    List the engagements the caller leads, as engagement partner, engagement manager, quality reviewer or PMO lead, most recently updated first. Use this to answer "which engagements am I responsible for".

    Scope
    delivery:read
    Calls
    GET /v1/engagements/my
    Example prompt
    Which engagements am I responsible for?

    Arguments

    This tool takes no arguments.

    Get delivery portfolio metrics

    Read only

    atlas_delivery_portfolio_metrics_get

    The firm-wide delivery metrics across every engagement the caller can see: health, schedule and delivery performance in one view. Use this for a portfolio review rather than a question about one engagement.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/portfolio/metrics
    Example prompt
    How is the delivery portfolio performing overall?

    Arguments

    This tool takes no arguments.

    List delivery rollup actions

    Read only

    atlas_delivery_rollup_actions_list

    The open actions across every engagement the caller can see, with owners and due dates. Use this to answer "what actions are outstanding".

    Scope
    delivery:read
    Calls
    GET /v1/engagements/rollup/actions
    Example prompt
    Which engagement actions are still open across the firm?

    Arguments

    This tool takes no arguments.

    List delivery rollup approvals

    Read only

    atlas_delivery_rollup_approvals_list

    The change request approval steps waiting for a decision across every engagement the caller can see. Use this to answer "which changes are waiting for approval".

    Scope
    delivery:read
    Calls
    GET /v1/engagements/rollup/approvals
    Example prompt
    Which change requests are waiting for approval?

    Arguments

    This tool takes no arguments.

    List delivery rollup exports

    Read only

    atlas_delivery_rollup_exports_list

    The document exports across every engagement the caller can see, with their state. Use this to find an export that was queued earlier.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/rollup/exports
    Example prompt
    Where is the status pack export I queued earlier?

    Arguments

    This tool takes no arguments.

    List delivery rollup info requests

    Read only

    atlas_delivery_rollup_info_requests_list

    The open information requests across every engagement the caller can see, including what is overdue. Use this to answer "what are we waiting on from clients".

    Scope
    delivery:read
    Calls
    GET /v1/engagements/rollup/info-requests
    Example prompt
    What are we still waiting on from clients across the portfolio?

    Arguments

    This tool takes no arguments.

    List delivery rollup meetings

    Read only

    atlas_delivery_rollup_meetings_list

    The most recent governed meetings across every engagement the caller can see, with their dates and the state of their minutes. Use this to answer "whose minutes are still outstanding".

    Scope
    delivery:read
    Calls
    GET /v1/engagements/rollup/meetings
    Example prompt
    Which recent governance meetings still have minutes outstanding?

    Arguments

    This tool takes no arguments.

    Get delivery rollup portfolio

    Read only

    atlas_delivery_rollup_portfolio_get

    The portfolio rollup: the engagement counters and the most recently updated engagements the caller can see, in one read. Use this for a portfolio dashboard; use atlas_delivery_engagements_list to page through every engagement.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/rollup/portfolio
    Example prompt
    Give me the delivery portfolio dashboard.

    Arguments

    This tool takes no arguments.

    List delivery rollup RAID items

    Read only

    atlas_delivery_rollup_raid_items_list

    The open risks, assumptions, issues and dependencies across every engagement the caller can see, with their scores. Use this to answer "what are the biggest risks across the portfolio".

    Scope
    delivery:read
    Calls
    GET /v1/engagements/rollup/raid
    Example prompt
    What are the hottest open risks across all engagements?

    Arguments

    This tool takes no arguments.

    Set delivery templates collections

    Changes data

    atlas_delivery_templates_collections_set

    Replace one collection of a playbook, for example its phases or its deliverables, with the list sent. The list replaces the collection whole, so an item left out is removed. Returns the playbook, or the rules the list breaks.

    Scope
    delivery:write
    Calls
    PUT /v1/engagements/templates/{slug}/collections/{collection}
    Example prompt
    Replace the phases of our forensic review playbook with these four.

    Arguments

    FieldTypeRequiredDescription
    slugstringYesThe playbook slug, as the template list returns it.
    collection"phases" | "workstreams" | "deliverables" | "raci" | "raidStarters" | "meetings" | "infoRequests" | "closureItems" | "statusReportSections" | "checks"YesWhich collection of the playbook to replace.
    itemsarray of objectYesEvery item of the collection, in order. Read the playbook first to see the shape each item takes.

    Create delivery templates

    Changes data

    atlas_delivery_templates_create

    Write a new playbook for the workspace, starting empty. Fill its collections afterwards with the collection tool. Requires the administrator role in client delivery.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/templates
    Example prompt
    Create a new playbook for forensic reviews.

    Arguments

    FieldTypeRequiredDescription
    slugstringYesA short unique key for the playbook, in lowercase with hyphens.
    category"STRATEGY_ADVISORY" | "TECHNOLOGY_IMPLEMENTATION" | "MANAGED_SERVICE" | "INTERNAL_AUDIT" | "REGULATORY_REMEDIATION" | "DUE_DILIGENCE" | "TRANSFORMATION_PMO" | "RETAINER" | "STAFF_AUGMENTATION" | "TRAINING"YesThe kind of engagement the playbook is for.
    namestringYesThe playbook name.
    headlinestringYesA one-line summary of the playbook.
    detailstringYesThe full description of the playbook.
    typicalDurationWeeksintegerYesHow many weeks an engagement of this kind usually runs.

    Delete delivery templates

    Destructive

    atlas_delivery_templates_delete

    Delete a playbook the workspace wrote. A customised built-in is reset rather than deleted. Engagements already started from it are unchanged, because an engagement holds a copy.

    Scope
    delivery:write
    Calls
    DELETE /v1/engagements/templates/{slug}
    Example prompt
    Delete the forensic review playbook we no longer use.

    Arguments

    FieldTypeRequiredDescription
    slugstringYesThe playbook slug, as the template list returns it.

    Fork delivery templates

    Changes data

    atlas_delivery_templates_fork

    Take a copy of a built-in playbook so the workspace can edit it. Every engagement started from it afterwards takes the edited copy. Returns the workspace copy.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/templates/{slug}/customise
    Example prompt
    Make an editable copy of the built-in retainer playbook.

    Arguments

    FieldTypeRequiredDescription
    slugstringYesThe playbook slug, as the template list returns it.

    Get delivery templates

    Read only

    atlas_delivery_templates_get

    Read one playbook in full: its phases, workstreams, deliverables, responsibility matrix, starter risks, meetings, information requests, closure items, report sections and checks.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/templates/{slug}
    Example prompt
    Show me what the retainer playbook sets up.

    Arguments

    FieldTypeRequiredDescription
    slugstringYesThe playbook slug, as the template list returns it.

    List delivery templates

    Read only

    atlas_delivery_templates_list

    List the engagement playbooks available in the workspace: the built-in ones and any the workspace wrote or customised. Use this to choose a playbook before applying it to an engagement.

    Scope
    delivery:read
    Calls
    GET /v1/engagements/templates
    Example prompt
    Which engagement playbooks do we have?

    Arguments

    This tool takes no arguments.

    Reset delivery templates

    Destructive

    atlas_delivery_templates_reset

    Drop the workspace copy of a built-in playbook, restoring the built-in exactly. The edits in the copy are lost.

    Scope
    delivery:write
    Calls
    POST /v1/engagements/templates/{slug}/reset
    Example prompt
    Reset our retainer playbook to the built-in version.

    Arguments

    FieldTypeRequiredDescription
    slugstringYesThe playbook slug, as the template list returns it.

    Update delivery templates

    Changes data

    atlas_delivery_templates_update

    Change the name, headline, detail or typical duration of a playbook the workspace wrote or customised. Engagements already started from it are unchanged.

    Scope
    delivery:write
    Calls
    PATCH /v1/engagements/templates/{slug}
    Example prompt
    Change the typical duration of our forensic review playbook to twelve weeks.

    Arguments

    FieldTypeRequiredDescription
    slugstringYesThe playbook slug, as the template list returns it.
    namestringNoThe playbook name.
    headlinestringNoA one-line summary of the playbook.
    detailstringNoThe full description of the playbook.
    typicalDurationWeeksintegerNoHow many weeks an engagement of this kind usually runs.

    Get delivery vocabulary

    Read only

    atlas_delivery_vocabulary_get

    The vocabularies this workspace uses: the follow-up rules with their kind, subject and default lead time, and the kinds, statuses and channels a follow-up can carry. Read this before writing to the module, so the values you send are ones the workspace actually accepts rather than a copy that drifted a release ago.

    Scope
    delivery:read
    Calls
    GET /v1/client-delivery/config/vocabulary
    Example prompt
    What follow-up kinds and statuses does this workspace accept?

    Arguments

    This tool takes no arguments.