Skip to main content

Integrations and requests

How grants, approvals and connection modes work is explained in Integrations. App code calls integrations through tc.int, not these endpoints.

Catalog​

GET /api/integrations

Integrations IT has connected. Any signed-in user; Org Admins see more detail.

Response 200: { "integrations": [ … ] }.

A project's integrations​

GET /api/projects/:name/integrations

Everything on the project's Integrations tab. Auth: view.

Response 200

FieldDescription
grantsActive grants
requestsThe project's access requests
connectionsYour own per-person connections (delegated OAuth)
needsWhat the production deployment's code uses, from the deploy scan
callsThe last 30 gateway calls, with who made them
dataSourcesShared Microsoft 365 data sources
appUrlThe app's URL

Request access​

POST /api/projects/:name/requests
{ "integration": "salesforce", "scopes": ["Case:read"], "identity": "user", "purpose": "Support leads see open escalations by account owner" }

identity is user (default: as each signed-in user) or project (as the app, for jobs). Auth: manage.

Response 201: { status, autoApproved, request, grant }, where status is covered, granted (a policy approved it), pending or denied.

Errors: 400 BAD_REQUEST, 400 PURPOSE_REQUIRED.

Share a file's data with everyone in the app​

POST /api/projects/:name/share-data
{ "file": "https://contoso.sharepoint.com/sites/Finance/Shared Documents/Budget FY27.xlsx", "purpose": "Everyone on the team sees the budget" }

Asks to show a Microsoft 365 file's data to everyone who can open the app (a snapshot read as the app). Auth: manage. Response 201: { request, autoApproved, grant }.

Revoke a grant​

DELETE /api/projects/:name/grants/:id

Auth: manage. Response 200: { "grant": … }.

Disconnect your account​

POST /api/projects/:name/integrations/:integration/disconnect

Drops your own connection to a delegated-OAuth integration. Anyone signed in. Response 200: { "connection": … }.

Access requests and approvals​

List​

GET /api/requests?box=inbox&status=pending&project=:name
QueryValues
boxinbox (default: requests routed to you), mine (requests you made), all (org admins and auditors)
statuspending (default), decided, or anything else for all
projectFilter by project

Response 200: { "requests": [Request], "counts": { "inbox": 3, "mine": 1 } }. Auto-approved requests are left out of inbox and mine.

Get​

GET /api/requests/:id

Visible to the requester, the project owner, the routed approvers, org admins and auditors. Response 200: { request, messages, grant }. Others get 404 REQUEST_NOT_FOUND.

Act on a request​

MethodPathBodyWho
POST/api/requests/:id/approve{ scopes?, readOnly?, expiresInDays?, note? }A routed approver or org admin. Pass narrower scopes or readOnly to approve less than asked.
POST/api/requests/:id/deny{ reason }A routed approver or org admin
POST/api/requests/:id/messages{ body }Anyone who can see the request (questions and answers)
POST/api/requests/:id/withdrawThe requester

Approve returns { request, grant }; deny and withdraw return { request }; messages returns 201 { message }. Approvals take effect at once; apps don't need a redeploy.

Scheduled jobs​

MethodPathAuthWhat it does
GET/api/projects/:name/jobsviewCron and worker services of the production deployment (name, type, schedule, command, nextRunAt, lastRun) and recent runs
POST/api/projects/:name/jobs/:service/run?wait=true&timeout=120manageRun a cron job now. 202 { run }, or with wait=true the finished run.
GET/api/projects/:name/jobs/runs/:idviewOne run

Errors: 409 NO_DEPLOYMENTS, 404 NO_SUCH_JOB, 400 NOT_A_CRON (workers run all the time), 404 NO_SUCH_RUN.

Was this page helpful?