Endpoints

Users

Copy page

Operations for managing users

Create Nango Connect Session

POST
/work-apps/slack/users/connect

Authorization

bearerAuth cookieAuth
AuthorizationBearer <token>

Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".

In: header

better-auth.session_token<token>

Session-based authentication using HTTP-only cookies. Cookies are automatically sent by browsers. For server-side requests, include cookies with names starting with "better-auth." in the Cookie header.

In: cookie

Request Body

application/json

sessionExpiresAt?string

Session expiration ISO timestamp

sessionToken?string

Pre-authenticated session token

tenantId?string

Tenant ID

userEmail?string

User email

userId*string

Inkeep user ID

userName?string

User display name

Response Body

application/json

curl -X POST "https://api.pilot.inkeep.com/work-apps/slack/users/connect" \  -H "Content-Type: application/json" \  -d '{    "userId": "string"  }'
{
  "connectUrl": "string",
  "sessionToken": "string"
}
Empty
Empty

Disconnect User

POST
/work-apps/slack/users/disconnect

Authorization

bearerAuth cookieAuth
AuthorizationBearer <token>

Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".

In: header

better-auth.session_token<token>

Session-based authentication using HTTP-only cookies. Cookies are automatically sent by browsers. For server-side requests, include cookies with names starting with "better-auth." in the Cookie header.

In: cookie

Request Body

application/json

connectionId?string

Nango connection ID

slackTeamId?string

Slack team ID

slackUserId?string

Slack user ID

tenantId?string

Tenant ID

userId?string

Inkeep user ID

Response Body

application/json

curl -X POST "https://api.pilot.inkeep.com/work-apps/slack/users/disconnect" \  -H "Content-Type: application/json" \  -d '{}'
{
  "connectionId": "string",
  "success": true
}
Empty
Empty
Empty
GET
/work-apps/slack/users/link-status

Authorization

bearerAuth cookieAuth
AuthorizationBearer <token>

Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".

In: header

better-auth.session_token<token>

Session-based authentication using HTTP-only cookies. Cookies are automatically sent by browsers. For server-side requests, include cookies with names starting with "better-auth." in the Cookie header.

In: cookie

Query Parameters

slackUserId*string
slackTeamId*string
tenantId?string
Default"default"

Response Body

application/json

curl -X GET "https://api.pilot.inkeep.com/work-apps/slack/users/link-status?slackUserId=string&slackTeamId=string"
{
  "linkId": "string",
  "linked": true,
  "linkedAt": "string",
  "slackUsername": "string"
}
POST
/work-apps/slack/users/link/verify-token

Authorization

bearerAuth cookieAuth
AuthorizationBearer <token>

Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".

In: header

better-auth.session_token<token>

Session-based authentication using HTTP-only cookies. Cookies are automatically sent by browsers. For server-side requests, include cookies with names starting with "better-auth." in the Cookie header.

In: cookie

Request Body

application/json

token*string
Length1 <= length
userEmail?string
Formatemail
userId*string
Length1 <= length

Response Body

application/json

curl -X POST "https://api.pilot.inkeep.com/work-apps/slack/users/link/verify-token" \  -H "Content-Type: application/json" \  -d '{    "token": "string",    "userId": "string"  }'
{
  "linkId": "string",
  "slackTeamId": "string",
  "slackUsername": "string",
  "success": true,
  "tenantId": "string"
}
Empty
Empty

Get User Settings

GET
/work-apps/slack/users/me/settings

Authorization

bearerAuth cookieAuth
AuthorizationBearer <token>

Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".

In: header

better-auth.session_token<token>

Session-based authentication using HTTP-only cookies. Cookies are automatically sent by browsers. For server-side requests, include cookies with names starting with "better-auth." in the Cookie header.

In: cookie

Query Parameters

slackUserId*string
slackTeamId*string
tenantId?string
Default"default"

Response Body

application/json

curl -X GET "https://api.pilot.inkeep.com/work-apps/slack/users/me/settings?slackUserId=string&slackTeamId=string"
{
  "defaultAgentId": "string",
  "defaultAgentName": "string",
  "defaultProjectId": "string"
}

Update User Settings

PUT
/work-apps/slack/users/me/settings

Authorization

bearerAuth cookieAuth
AuthorizationBearer <token>

Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".

In: header

better-auth.session_token<token>

Session-based authentication using HTTP-only cookies. Cookies are automatically sent by browsers. For server-side requests, include cookies with names starting with "better-auth." in the Cookie header.

In: cookie

Request Body

application/json

settings*
slackTeamId*string
slackUserId*string
tenantId?string

Response Body

application/json

curl -X PUT "https://api.pilot.inkeep.com/work-apps/slack/users/me/settings" \  -H "Content-Type: application/json" \  -d '{    "settings": {},    "slackTeamId": "string",    "slackUserId": "string"  }'
{
  "success": true
}

Refresh Session Token

POST
/work-apps/slack/users/refresh-session

Authorization

bearerAuth cookieAuth
AuthorizationBearer <token>

Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".

In: header

better-auth.session_token<token>

Session-based authentication using HTTP-only cookies. Cookies are automatically sent by browsers. For server-side requests, include cookies with names starting with "better-auth." in the Cookie header.

In: cookie

Request Body

application/json

sessionExpiresAt?string

Session expiration ISO timestamp

sessionToken*string

New session token

userId*string

Inkeep user ID

Response Body

application/json

curl -X POST "https://api.pilot.inkeep.com/work-apps/slack/users/refresh-session" \  -H "Content-Type: application/json" \  -d '{    "sessionToken": "string",    "userId": "string"  }'
{
  "connectionId": "string",
  "success": true
}
Empty
Empty
Empty

Get Connection Status

GET
/work-apps/slack/users/status

Authorization

bearerAuth cookieAuth
AuthorizationBearer <token>

Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".

In: header

better-auth.session_token<token>

Session-based authentication using HTTP-only cookies. Cookies are automatically sent by browsers. For server-side requests, include cookies with names starting with "better-auth." in the Cookie header.

In: cookie

Query Parameters

userId*string

Inkeep user ID

Response Body

application/json

curl -X GET "https://api.pilot.inkeep.com/work-apps/slack/users/status?userId=string"
{
  "connected": true,
  "connection": {
    "appUserEmail": "string",
    "appUserId": "string",
    "connectionId": "string",
    "linkedAt": "string",
    "slackDisplayName": "string",
    "slackTeamId": "string",
    "slackUserId": "string",
    "tenantId": "string"
  }
}
Empty
Empty

List Linked Users

GET
/work-apps/slack/workspaces/:teamId/users

Authorization

bearerAuth cookieAuth
AuthorizationBearer <token>

Bearer token authentication. Use this for API clients and service-to-service communication. Set the Authorization header to "Bearer ".

In: header

better-auth.session_token<token>

Session-based authentication using HTTP-only cookies. Cookies are automatically sent by browsers. For server-side requests, include cookies with names starting with "better-auth." in the Cookie header.

In: cookie

Path Parameters

teamId*string

Response Body

application/json

curl -X GET "https://api.pilot.inkeep.com/work-apps/slack/workspaces/:teamId/users"
{
  "linkedUsers": [
    {
      "id": "string",
      "lastUsedAt": "string",
      "linkedAt": "string",
      "slackEmail": "string",
      "slackTeamId": "string",
      "slackUserId": "string",
      "slackUsername": "string",
      "userId": "string"
    }
  ]
}