generated: '2026-10-19' method: derived generator: derive-vocabulary.py source: openapi/crm-switchlabs-openapi.json vocabulary: name: Switch Labs Domain Vocabulary description: 'Terms declared by Switch Labs''s own API contract: its resource groups, objects and enumerations, with the contract''s definitions. Derived, not authored.' version: '2026-10-19' terms: - term: ErrorResponse definition: 'Object declared by the contract with fields: error.' tags: - Object source: openapi/crm-switchlabs-openapi.json#/components/schemas/ErrorResponse - term: PaginationMeta definition: 'Object declared by the contract with fields: total, limit, next_cursor.' tags: - Object source: openapi/crm-switchlabs-openapi.json#/components/schemas/PaginationMeta - term: Ticket definition: 'Object declared by the contract with fields: id, subject, status, priority, created_at, updated_at.' tags: - Object source: openapi/crm-switchlabs-openapi.json#/components/schemas/Ticket - term: Customer definition: 'Object declared by the contract with fields: id, email, name, created_at.' tags: - Object source: openapi/crm-switchlabs-openapi.json#/components/schemas/Customer - term: Conversation definition: 'Object declared by the contract with fields: id, ticket_id, type, internal, created_at.' tags: - Object source: openapi/crm-switchlabs-openapi.json#/components/schemas/Conversation - term: Article definition: 'Object declared by the contract with fields: id, title, slug, status, created_at.' tags: - Object source: openapi/crm-switchlabs-openapi.json#/components/schemas/Article - term: Collection definition: 'Object declared by the contract with fields: id, name, created_at.' tags: - Object source: openapi/crm-switchlabs-openapi.json#/components/schemas/Collection - term: Automation definition: 'Object declared by the contract with fields: id, name, enabled, created_at.' tags: - Object source: openapi/crm-switchlabs-openapi.json#/components/schemas/Automation - term: Macro definition: 'Object declared by the contract with fields: id, name, created_at.' tags: - Object source: openapi/crm-switchlabs-openapi.json#/components/schemas/Macro - term: SlaPolicy definition: 'Object declared by the contract with fields: id, name, created_at.' tags: - Object source: openapi/crm-switchlabs-openapi.json#/components/schemas/SlaPolicy - term: User definition: 'Object declared by the contract with fields: id, name, email, role.' tags: - Object source: openapi/crm-switchlabs-openapi.json#/components/schemas/User - term: Notification definition: 'Object declared by the contract with fields: id, type, read_at.' tags: - Object source: openapi/crm-switchlabs-openapi.json#/components/schemas/Notification - term: Event definition: 'Object declared by the contract with fields: id, type, created_at.' tags: - Object source: openapi/crm-switchlabs-openapi.json#/components/schemas/Event - term: Integration definition: 'Object declared by the contract with fields: id, name, provider.' tags: - Object source: openapi/crm-switchlabs-openapi.json#/components/schemas/Integration - term: Webhook definition: 'Object declared by the contract with fields: id, event, target_url.' tags: - Object source: openapi/crm-switchlabs-openapi.json#/components/schemas/Webhook - term: Attachment definition: 'Object declared by the contract with fields: id, filename, content_type, size, url.' tags: - Object source: openapi/crm-switchlabs-openapi.json#/components/schemas/Attachment - term: Tag definition: 'Object declared by the contract with fields: id, name.' tags: - Object source: openapi/crm-switchlabs-openapi.json#/components/schemas/Tag - term: Sequence definition: 'Object declared by the contract with fields: id, organization_id, name, description, trigger_type, status, from_email, from_name, reply_to_email, total_enrolled, total_completed, total_unsubscribed. (1 more)' tags: - Object source: openapi/crm-switchlabs-openapi.json#/components/schemas/Sequence - term: SequenceEnrollment definition: 'Object declared by the contract with fields: id, sequence_id, customer_id, organization_id, status, current_step_position, next_send_at, enrollment_source, enrolled_at.' tags: - Object source: openapi/crm-switchlabs-openapi.json#/components/schemas/SequenceEnrollment - term: Campaign definition: 'Object declared by the contract with fields: id, organization_id, name, subject, status, list_id, view_id, integration_id, scheduled_at, total_recipients, total_sent, total_opened. (2 more)' tags: - Object source: openapi/crm-switchlabs-openapi.json#/components/schemas/Campaign - term: MarketingList definition: 'Object declared by the contract with fields: id, organization_id, name, description, opt_in_process, status, member_count, created_at.' tags: - Object source: openapi/crm-switchlabs-openapi.json#/components/schemas/MarketingList - term: ListMembership definition: 'Object declared by the contract with fields: id, list_id, customer_id, organization_id, status, source, subscribed_at.' tags: - Object source: openapi/crm-switchlabs-openapi.json#/components/schemas/ListMembership - term: Deal definition: 'Object declared by the contract with fields: id, organization_id, pipeline_id, stage_id, name, amount, currency, status, priority, customer_id, owner_id, position. (1 more)' tags: - Object source: openapi/crm-switchlabs-openapi.json#/components/schemas/Deal - term: Tickets definition: 'Resource group in the contract; its operation GET /tickets: List tickets' tags: - Resource Group source: openapi/crm-switchlabs-openapi.json - term: Customers definition: 'Resource group in the contract; its operation GET /customers: List customers' tags: - Resource Group source: openapi/crm-switchlabs-openapi.json - term: Conversations definition: 'Resource group in the contract; its operation GET /conversations: List conversations' tags: - Resource Group source: openapi/crm-switchlabs-openapi.json - term: Articles definition: 'Resource group in the contract; its operation GET /articles: List articles' tags: - Resource Group source: openapi/crm-switchlabs-openapi.json - term: Collections definition: 'Resource group in the contract; its operation GET /collections: List collections' tags: - Resource Group source: openapi/crm-switchlabs-openapi.json - term: Automations definition: 'Resource group in the contract; its operation GET /automations: List automations' tags: - Resource Group source: openapi/crm-switchlabs-openapi.json - term: Macros definition: 'Resource group in the contract; its operation GET /macros: List macros' tags: - Resource Group source: openapi/crm-switchlabs-openapi.json - term: SLA definition: 'Resource group in the contract; its operation GET /sla: List SLA policies' tags: - Resource Group source: openapi/crm-switchlabs-openapi.json - term: Users definition: 'Resource group in the contract; its operation GET /users: List users' tags: - Resource Group source: openapi/crm-switchlabs-openapi.json - term: Notifications definition: 'Resource group in the contract; its operation GET /notifications: List notifications' tags: - Resource Group source: openapi/crm-switchlabs-openapi.json - term: Events definition: 'Resource group in the contract; its operation GET /events: List events' tags: - Resource Group source: openapi/crm-switchlabs-openapi.json - term: Analytics definition: 'Resource group in the contract; its operation GET /analytics: Get analytics' tags: - Resource Group source: openapi/crm-switchlabs-openapi.json - term: Search definition: 'Resource group in the contract; its operation GET /search: Search resources' tags: - Resource Group source: openapi/crm-switchlabs-openapi.json - term: Integrations definition: 'Resource group in the contract; its operation GET /integrations: List integrations' tags: - Resource Group source: openapi/crm-switchlabs-openapi.json - term: Webhooks definition: 'Resource group in the contract; its operation GET /webhooks: List webhooks' tags: - Resource Group source: openapi/crm-switchlabs-openapi.json - term: Attachments definition: 'Resource group in the contract; its operation GET /attachments: Deprecated and not available: every method returns 501 NOT_IMPLEMENTED.' tags: - Resource Group source: openapi/crm-switchlabs-openapi.json - term: Tags definition: 'Resource group in the contract; its operation GET /tags: List tags' tags: - Resource Group source: openapi/crm-switchlabs-openapi.json - term: Help Center definition: 'Resource group in the contract; its operation GET /help-center: Get help center settings' tags: - Resource Group source: openapi/crm-switchlabs-openapi.json - term: Business Hours definition: 'Resource group in the contract; its operation GET /business-hours: Get business hours' tags: - Resource Group source: openapi/crm-switchlabs-openapi.json - term: Saved Views definition: 'Resource group in the contract; its operation GET /saved-views: List saved views' tags: - Resource Group source: openapi/crm-switchlabs-openapi.json - term: Sequences definition: 'Resource group in the contract; its operation GET /sequences: List sequences' tags: - Resource Group source: openapi/crm-switchlabs-openapi.json - term: Campaigns definition: 'Resource group in the contract; its operation GET /campaigns: List campaigns' tags: - Resource Group source: openapi/crm-switchlabs-openapi.json - term: Marketing Lists definition: 'Resource group in the contract; its operation GET /marketing-lists: List marketing lists' tags: - Resource Group source: openapi/crm-switchlabs-openapi.json - term: Deals definition: 'Resource group in the contract; its operation GET /deals: List deals' tags: - Resource Group source: openapi/crm-switchlabs-openapi.json