API referenceAPIAvailable

Apps

Manage connected apps used by Vendo as sources and destinations.

Last reviewed July 13, 2026

Apps are authenticated connections to external platforms such as Shopify, Stripe, Mixpanel, Google Ads, and Meta Ads.

Each app can support one or both roles:

source
destination

List Apps


GET /api/v1/apps

Query Parameters

Parameter	Type	Description
`limit`	integer	Number of items to return
`offset`	integer	Number of items to skip
`sort`	string	Sort by `created_at`, `updated_at`, or `display_name`
`state`	string	Filter by `active`, `inactive`, `deleted`
`role`	string	Filter by `source` or `destination`
`app_type`	string	Filter by app type such as `shopify` or `mixpanel`

Example Response


{
  "data": [
    {
      "id": "app_123",
      "accountId": "acct_123",
      "appType": "shopify",
      "displayName": "My Shopify Store",
      "role": ["source"],
      "state": "active",
      "errorMessage": null,
      "lastSyncAt": "2026-04-02T00:00:00Z",
      "createdAt": "2026-04-01T00:00:00Z",
      "updatedAt": "2026-04-02T00:00:00Z"
    }
  ]
}

Get App Details


GET /api/v1/apps/{appId}

Detail responses include:

permissions
config
consecutiveFailureCount

Sensitive values are sanitized before they are returned.

Create App


POST /api/v1/apps

Request Body

Field	Type	Required	Description
`appType`	string	Yes	App type identifier
`displayName`	string	Yes	Human-readable connection name
`role`	string[]	No	One or both of `source` and `destination`
`credentials`	object	No	App credentials
`config`	object	No	App configuration

Apps created without credentials start in inactive state. Apps created with credentials start in active state.

Update App


PATCH /api/v1/apps/{appId}

Supported updates:

displayName
credentials
config
role

Delete App


DELETE /api/v1/apps/{appId}

Apps are soft-deleted. Deletion is blocked while active sources are still using the app.