# Get a connector app

> One app's actions and triggers, each with the module_id and module_version the module form takes.

Source: https://docs.stacksync.com/api-reference/connectors/get_connector_app

`GET https://api.stacksync.com/v1/workspaces/{workspace_id}/workflows/modules/apps/{app_type}`

- Operation: `get_connector_app`
- Resource: Connectors
- Access: read-only

## Authentication

- `Authorization: Bearer <key>`: A workspace API key (workspace_…, created by a workspace owner under Workspace settings > Stacksync API) acts with editor rights on that workspace only; a user API key (user_…, created under Profile > Stacksync API) acts as that user in every workspace they belong to. POST, PUT and PATCH requests must send Content-Type: application/json. Every authentication failure answers 403.

## Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `workspace_id` | integer | Yes | The workspace. List the ones your key can reach with GET /v1/workspaces. |
| `app_type` | string | Yes | The connector's app type, as listed by List connector apps. |

## Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `region` | string (besg \| usnv) | Yes | Region whose catalog to read: besg or usnv |

## Returns

### 200 OK

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `app_type` | string | Yes |  |
| `actions` | array of object (WorkflowModuleSummary) | Yes |  |
| `actions[].module_id` | string | Yes |  |
| `actions[].module_version` | string | Yes |  |
| `actions[].module_name` | string | Yes |  |
| `actions[].module_description` | string | Yes |  |
| `actions[].is_connection_required` | boolean | Yes |  |
| `actions[].connection_app_types` | array of string | Yes | The app types of the connections the module accepts |
| `actions[].is_read_action` | boolean \| null | Yes | For an action, True when it only reads from the app (a viewer may run it), False when it can change data; None for a trigger |
| `triggers` | array of object (WorkflowModuleSummary) | Yes |  |
| `triggers[].module_id` | string | Yes |  |
| `triggers[].module_version` | string | Yes |  |
| `triggers[].module_name` | string | Yes |  |
| `triggers[].module_description` | string | Yes |  |
| `triggers[].is_connection_required` | boolean | Yes |  |
| `triggers[].connection_app_types` | array of string | Yes | The app types of the connections the module accepts |
| `triggers[].is_read_action` | boolean \| null | Yes | For an action, True when it only reads from the app (a viewer may run it), False when it can change data; None for a trigger |

## Example request

```bash
curl -X GET "https://api.stacksync.com/v1/workspaces/{workspace_id}/workflows/modules/apps/{app_type}?region=usnv" \
  -H "Authorization: Bearer $STACKSYNC_API_KEY"
```

## Example response (200)

```json
{
  "app_type": "<app_type>",
  "actions": [
    {
      "module_id": "<module_id>",
      "module_version": "<module_version>",
      "module_name": "<module_name>",
      "module_description": "<module_description>",
      "is_connection_required": false,
      "connection_app_types": [
        "<connection_app_types>"
      ],
      "is_read_action": false
    }
  ],
  "triggers": [
    {
      "module_id": "<module_id>",
      "module_version": "<module_version>",
      "module_name": "<module_name>",
      "module_description": "<module_description>",
      "is_connection_required": false,
      "connection_app_types": [
        "<connection_app_types>"
      ],
      "is_read_action": false
    }
  ]
}
```

## Errors

| Status | Meaning | Body |
| --- | --- | --- |
| 400 | Bad Request | `{ "error": string, "msg": string, "field": string \| null }` |
| 403 | Forbidden | `{ "error": string, "msg": string, "field": string \| null }` |
| 404 | Not Found | `{ "error": string, "msg": string, "field": string \| null }` |

## Related

- [API Reference overview](https://docs.stacksync.com/api-reference): base URLs, regions, pagination, idempotency and errors
- [Authentication](https://docs.stacksync.com/api-reference/authentication): API keys and the 403 answers
- OpenAPI document: https://docs.stacksync.com/openapi.json
- [List connector apps](https://docs.stacksync.com/api-reference/connectors/list_connector_apps)
- [Get a connector module form](https://docs.stacksync.com/api-reference/connectors/get_connector_module_form)
- [Run an action](https://docs.stacksync.com/api-reference/connectors/run_connector_module)