{
  "opencollection": "1.0.0",
  "info": {
    "name": "Amigo Account Workspaces API",
    "version": "0.1.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Workspaces",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get a workspace",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.amigo.ai/v1/workspaces/:workspace_id",
            "params": [
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve a workspace by ID. Requires `Workspace.view` permission."
        },
        {
          "info": {
            "name": "Update a workspace",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.amigo.ai/v1/workspaces/:workspace_id",
            "params": [
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update workspace fields. Requires `Workspace.update` permission."
        },
        {
          "info": {
            "name": "List workspaces",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.amigo.ai/v1/workspaces",
            "params": [
              {
                "name": "limit",
                "value": "",
                "type": "query"
              },
              {
                "name": "continuation_token",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "List workspaces accessible to this API key. Requires `Workspace.view` permission."
        },
        {
          "info": {
            "name": "Provision workspace resources",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.amigo.ai/v1/workspaces/:workspace_id/provision",
            "params": [
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Seed default integrations and mark workspace as provisioned. Idempotent. Requires `Workspace.update` permission."
        },
        {
          "info": {
            "name": "Archive a workspace",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.amigo.ai/v1/workspaces/:workspace_id/archive",
            "params": [
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Archive a workspace and remove it from active access flows while preserving underlying data. Requires owner access and slug confirmation."
        },
        {
          "info": {
            "name": "Pre-check environment conversion",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.amigo.ai/v1/workspaces/:workspace_id/environment-check",
            "params": [
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              },
              {
                "name": "target",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Returns compliance warnings for converting between staging and production. Does not mutate."
        },
        {
          "info": {
            "name": "Convert workspace environment",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.amigo.ai/v1/workspaces/:workspace_id/convert-environment",
            "params": [
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Convert workspace between staging and production. Requires slug confirmation."
        },
        {
          "info": {
            "name": "Get test caller numbers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.amigo.ai/v1/workspaces/:workspace_id/test-caller-numbers",
            "params": [
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get phone numbers configured as test callers for this workspace."
        },
        {
          "info": {
            "name": "Update test caller numbers",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.amigo.ai/v1/workspaces/:workspace_id/test-caller-numbers",
            "params": [
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Set phone numbers to be treated as test callers. Calls from these numbers are tagged source='test' and excluded from billing, scores, analytics, outbound EHR sync, and entity views."
        },
        {
          "info": {
            "name": "Get test credential IDs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.amigo.ai/v1/workspaces/:workspace_id/test-credential-ids",
            "params": [
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get the credential IDs configured as test principals for this workspace's text channel."
        },
        {
          "info": {
            "name": "Update test credential IDs",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.amigo.ai/v1/workspaces/:workspace_id/test-credential-ids",
            "params": [
              {
                "name": "workspace_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Set credential IDs to be treated as test principals. Text turns from these credentials are tagged source='test' and excluded from billing, scores, analytics, outbound EHR sync, and entity views."
        }
      ]
    }
  ],
  "bundled": true
}