Skip to content
vocapable.Docs

The 26 tools, what each can do here, and this company's state

GET
/v1/workspace/integrations/catalog
curl --request GET \
  --url https://api.vocapable.com/v1/workspace/integrations/catalog \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
WorkspaceIntegrationCatalog
object
company_name
required
Company Name
string
categories
required
Categories
Array<string>
Allowed values: CRM & leads Scheduling Email & messaging Payments & documents Service & commerce Automation
entries
required
Entries
Array<object>
WorkspaceCatalogEntry
object
id
required
Id
string
slug
required
Slug
string
name
required
Name
string
mark
required
Mark
string
color
required
Color
string
category
required
Category
string
Allowed values: CRM & leads Scheduling Email & messaging Payments & documents Service & commerce Automation
recommended
required
Recommended
boolean
core
required
Any of:
string
job
required
Job
string
description
required
Description
string
access
required
Access
string
source
required
Source
string
fields
required
Fields
Array<string>
resource_label
required
Resource Label
string
resource_hint
required
Resource Hint
string
watch
required
Watch
string
auth
required
Auth
string
Allowed values: oauth api_key client_credentials workflow_url vocapable_key signed_destination
notes
required
Notes
Array<string>
capabilities
required
Capabilities
Array<object>
WorkspaceCatalogCapability
object
key
required
Key
string
label
required
Label
string
writes
required
Writes
boolean
availability
required
Availability
string
Allowed values: available needs_platform_credentials needs_vendor_approval customer_plan_required not_supported not_built
requirement_code
required
Any of:
string
requirement
required
Any of:
string
missing_platform_credentials
required
Missing Platform Credentials
Array<string>
connectable
required
Connectable
boolean
installation
required
Any of:
WorkspaceInstallationSummary

What a catalog card needs to say about the company’s installation of the tool.

object
id
required
Id
string
status
required
Status
string
Allowed values: draft awaiting_authorization checking_access review_required active attention_needed rate_limited paused reauthorization_required disconnected
status_reason
required
Any of:
string
external_account_label
required
Any of:
string
owner
required
Any of:
WorkspacePersonRef

A teammate named on a record: the id the server holds and the name to show.

object
user_id
required
User Id
string
name
required
Name
string
plan_reviewed
required
Plan Reviewed
boolean
updated_at
required
Updated At
string format: date-time
crm_home
required
WorkspaceCrmHome
object
mode
required
Mode
string
Allowed values: vocapable external
provider
required
Any of:
string
installation_id
required
Any of:
string
open_installations
required
Open Installations
integer
Example
{
  "categories": [
    "CRM & leads"
  ],
  "entries": [
    {
      "category": "CRM & leads",
      "auth": "oauth",
      "capabilities": [
        {
          "availability": "available"
        }
      ],
      "installation": {
        "status": "draft"
      }
    }
  ],
  "crm_home": {
    "mode": "vocapable"
  }
}