> ## Documentation Index
> Fetch the complete documentation index at: https://docs.runaether.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Slack install URL

> Returns the slack.com URL that installs Aether's Slack app in a workspace for the organization, with a state signed for the caller and the organization.

Use this tool when you need to:
- Connect a Slack workspace to the organization so mentions of Aether in its channels can start tasks
- Reconnect a workspace whose status has needs_reconnect true, so it grants the commands scope behind /aether and Send to Aether
- Move the organization to another Slack workspace

Examples:
- GET /orgs/{orgID}/auth/slack/url
- GET /orgs/6f1c2a9e-3b7d-4c55-9a2e-0d8b1f4e7c21/auth/slack/url?redirect_to=aether://slack-connected

Hints:
- orgID is the org's uuid; redirect_to is optional, at most 512 characters, and the schema answers 422 for a longer one or one that does not parse as a URL.
- Open the URL in a browser: the install happens on slack.com, and Slack must redirect back to Aether within 15 minutes of the URL being issued. Aether then returns to redirect_to once the install succeeds, if it is on Aether's own web origin or is the mobile app's aether://slack-connected; otherwise, and on any failure, it goes to the web settings page.
- The installer must still be an owner or admin when Slack redirects back. Reinstalling the same workspace keeps its routes, linked identities and default actor; installing another workspace deletes the previous one's routes and links; a workspace another organization has installed is refused (team_already_connected on the settings page).
- Use getSlackStatus instead to read whether Slack is connected or needs_reconnect, and disconnectSlack to remove it.
- Owners and admins only, with a session or a platform API key: a member, viewer or billing member is refused with 403 org_role_insufficient before redirect_to is validated, a non-member with 403 org_membership_required, an orgID that is not a uuid with 400, and an agent host's grant with 403 agent_host_route_not_allowed. A deployment without a Slack app answers 404 (getSlackStatus reads unavailable).



## OpenAPI

````yaml api-reference/openapi.json GET /orgs/{orgID}/auth/slack/url
openapi: 3.1.0
info:
  title: Aether API
  version: 0.1.0
servers:
  - url: https://api.runaether.dev
security:
  - bearerAuth: []
paths:
  /orgs/{orgID}/auth/slack/url:
    get:
      tags:
        - slack
      summary: Get Slack install URL
      description: >-
        Returns the slack.com URL that installs Aether's Slack app in a
        workspace for the organization, with a state signed for the caller and
        the organization.


        Use this tool when you need to:

        - Connect a Slack workspace to the organization so mentions of Aether in
        its channels can start tasks

        - Reconnect a workspace whose status has needs_reconnect true, so it
        grants the commands scope behind /aether and Send to Aether

        - Move the organization to another Slack workspace


        Examples:

        - GET /orgs/{orgID}/auth/slack/url

        - GET
        /orgs/6f1c2a9e-3b7d-4c55-9a2e-0d8b1f4e7c21/auth/slack/url?redirect_to=aether://slack-connected


        Hints:

        - orgID is the org's uuid; redirect_to is optional, at most 512
        characters, and the schema answers 422 for a longer one or one that does
        not parse as a URL.

        - Open the URL in a browser: the install happens on slack.com, and Slack
        must redirect back to Aether within 15 minutes of the URL being issued.
        Aether then returns to redirect_to once the install succeeds, if it is
        on Aether's own web origin or is the mobile app's
        aether://slack-connected; otherwise, and on any failure, it goes to the
        web settings page.

        - The installer must still be an owner or admin when Slack redirects
        back. Reinstalling the same workspace keeps its routes, linked
        identities and default actor; installing another workspace deletes the
        previous one's routes and links; a workspace another organization has
        installed is refused (team_already_connected on the settings page).

        - Use getSlackStatus instead to read whether Slack is connected or
        needs_reconnect, and disconnectSlack to remove it.

        - Owners and admins only, with a session or a platform API key: a
        member, viewer or billing member is refused with 403
        org_role_insufficient before redirect_to is validated, a non-member with
        403 org_membership_required, an orgID that is not a uuid with 400, and
        an agent host's grant with 403 agent_host_route_not_allowed. A
        deployment without a Slack app answers 404 (getSlackStatus reads
        unavailable).
      operationId: getSlackInstallUrl
      parameters:
        - in: path
          name: orgID
          required: true
          schema:
            format: uuid
            type: string
        - explode: false
          in: query
          name: redirect_to
          schema:
            format: uri
            maxLength: 512
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IntegrationInstallURL'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SlackErrorResponse'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SlackErrorResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrgAuthorizationErrorResponse'
          description: Forbidden
        '410':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SlackErrorResponse'
          description: Gone
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SlackErrorResponse'
          description: Unprocessable Entity
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SlackErrorResponse'
          description: Internal Server Error
components:
  schemas:
    IntegrationInstallURL:
      additionalProperties: false
      properties:
        url:
          format: uri
          minLength: 1
          type: string
      required:
        - url
      type: object
    SlackErrorResponse:
      additionalProperties: false
      properties:
        code:
          enum:
            - agent_profile_not_found
            - bad_gateway
            - bad_request
            - cli_upgrade_required
            - client_outdated
            - conflict
            - default_actor_not_member
            - forbidden
            - gateway_timeout
            - gone
            - internal_error
            - method_not_allowed
            - not_acceptable
            - not_connected
            - not_found
            - not_implemented
            - org_membership_required
            - payment_required
            - precondition_failed
            - project_not_found
            - project_repo_disconnected
            - rate_limited
            - request_canceled
            - request_timeout
            - request_too_large
            - route_exists
            - route_not_found
            - service_unavailable
            - slack_channel_not_found
            - slack_identity_link_invalid
            - unauthenticated
            - unsupported_media_type
            - validation_failed
          minLength: 1
          type: string
        error:
          minLength: 1
          type: string
        errors:
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
      required:
        - error
        - code
      type: object
    OrgAuthorizationErrorResponse:
      additionalProperties: false
      properties:
        code:
          enum:
            - org_membership_required
            - org_role_insufficient
            - org_suspended
            - account_deleting
            - agent_host_route_not_allowed
            - credential_kind_not_admitted
            - grant_scope_insufficient
          type: string
        error:
          minLength: 1
          type: string
      required:
        - error
        - code
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.