{ "service": "booqable", "displayName": "Booqable", "categories": [ "Productivity", "Data" ], "authTypes": [ "api_key" ], "auth": [ { "type": "api_key", "label": "Access Token", "placeholder": "BOOQABLE_ACCESS_TOKEN", "description": "Booqable access token sent with the Authorization: Bearer header. Create access tokens from your Booqable account settings: https://developers.booqable.com/api/authentication.md.", "extraFields": [ { "key": "companySlug", "label": "Company Slug", "inputType": "text", "required": true, "secret": false, "placeholder": "your-company", "description": "The Booqable company slug used to build https://.booqable.com/api/4 requests. Use only the subdomain before .booqable.com." } ] } ], "homepageUrl": "https://www.booqable.com/", "actions": [ { "id": "booqable.get_current_company", "service": "booqable", "name": "get_current_company", "description": "Fetch the current Booqable company connected to the access token.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "fields": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "description": "Comma-separated Booqable field names for one resource type." }, "description": "Booqable fields keyed by resource type, for example { customers: \"id,name\" }." }, "extraFields": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "description": "Comma-separated Booqable extra field names for one resource type." }, "description": "Booqable extra fields keyed by resource type, for example { companies: \"subscription\" }." } }, "additionalProperties": false, "description": "Fetch the current Booqable company for the connected access token." }, "outputSchema": { "type": "object", "properties": { "company": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Booqable resource id." }, "type": { "type": "string", "minLength": 1, "description": "The Booqable JSON:API resource type." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable resource attributes." }, "relationships": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable resource relationships." } }, "additionalProperties": true, "description": "A Booqable JSON:API resource object." }, "included": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Booqable resource id." }, "type": { "type": "string", "minLength": 1, "description": "The Booqable JSON:API resource type." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable resource attributes." }, "relationships": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable resource relationships." } }, "additionalProperties": true, "description": "A Booqable JSON:API resource object." }, "description": "JSON:API resources sideloaded by Booqable for this request." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API metadata returned by Booqable." } }, "additionalProperties": false, "description": "The current Booqable company response." } }, { "id": "booqable.get_customer", "service": "booqable", "name": "get_customer", "description": "Fetch one Booqable customer by id.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "customerId": { "type": "string", "minLength": 1, "description": "The Booqable customer id." }, "fields": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "description": "Comma-separated Booqable field names for one resource type." }, "description": "Booqable fields keyed by resource type, for example { customers: \"id,name\" }." }, "include": { "type": "string", "minLength": 1, "description": "Comma-separated Booqable relationships to sideload." } }, "additionalProperties": false, "required": [ "customerId" ], "description": "Fetch one Booqable customer." }, "outputSchema": { "type": "object", "properties": { "customer": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Booqable resource id." }, "type": { "type": "string", "minLength": 1, "description": "The Booqable JSON:API resource type." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable resource attributes." }, "relationships": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable resource relationships." } }, "additionalProperties": true, "description": "A Booqable JSON:API resource object." }, "included": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Booqable resource id." }, "type": { "type": "string", "minLength": 1, "description": "The Booqable JSON:API resource type." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable resource attributes." }, "relationships": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable resource relationships." } }, "additionalProperties": true, "description": "A Booqable JSON:API resource object." }, "description": "JSON:API resources sideloaded by Booqable for this request." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API metadata returned by Booqable." } }, "additionalProperties": false, "description": "The Booqable customer response." } }, { "id": "booqable.get_order", "service": "booqable", "name": "get_order", "description": "Fetch one Booqable order by id.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "orderId": { "type": "string", "minLength": 1, "description": "The Booqable order id." }, "fields": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "description": "Comma-separated Booqable field names for one resource type." }, "description": "Booqable fields keyed by resource type, for example { customers: \"id,name\" }." }, "include": { "type": "string", "minLength": 1, "description": "Comma-separated Booqable relationships to sideload." } }, "additionalProperties": false, "required": [ "orderId" ], "description": "Fetch one Booqable order." }, "outputSchema": { "type": "object", "properties": { "order": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Booqable resource id." }, "type": { "type": "string", "minLength": 1, "description": "The Booqable JSON:API resource type." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable resource attributes." }, "relationships": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable resource relationships." } }, "additionalProperties": true, "description": "A Booqable JSON:API resource object." }, "included": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Booqable resource id." }, "type": { "type": "string", "minLength": 1, "description": "The Booqable JSON:API resource type." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable resource attributes." }, "relationships": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable resource relationships." } }, "additionalProperties": true, "description": "A Booqable JSON:API resource object." }, "description": "JSON:API resources sideloaded by Booqable for this request." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API metadata returned by Booqable." } }, "additionalProperties": false, "description": "The Booqable order response." } }, { "id": "booqable.get_product_group", "service": "booqable", "name": "get_product_group", "description": "Fetch one Booqable product group by id.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "productGroupId": { "type": "string", "minLength": 1, "description": "The Booqable product group id." }, "fields": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "description": "Comma-separated Booqable field names for one resource type." }, "description": "Booqable fields keyed by resource type, for example { customers: \"id,name\" }." }, "include": { "type": "string", "minLength": 1, "description": "Comma-separated Booqable relationships to sideload." } }, "additionalProperties": false, "required": [ "productGroupId" ], "description": "Fetch one Booqable product group." }, "outputSchema": { "type": "object", "properties": { "productGroup": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Booqable resource id." }, "type": { "type": "string", "minLength": 1, "description": "The Booqable JSON:API resource type." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable resource attributes." }, "relationships": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable resource relationships." } }, "additionalProperties": true, "description": "A Booqable JSON:API resource object." }, "included": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Booqable resource id." }, "type": { "type": "string", "minLength": 1, "description": "The Booqable JSON:API resource type." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable resource attributes." }, "relationships": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable resource relationships." } }, "additionalProperties": true, "description": "A Booqable JSON:API resource object." }, "description": "JSON:API resources sideloaded by Booqable for this request." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API metadata returned by Booqable." } }, "additionalProperties": false, "description": "The Booqable product group response." } }, { "id": "booqable.list_customers", "service": "booqable", "name": "list_customers", "description": "List Booqable customers with optional fields, filters, includes, and paging.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "fields": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "description": "Comma-separated Booqable field names for one resource type." }, "description": "Booqable fields keyed by resource type, for example { customers: \"id,name\" }." }, "filter": { "type": "object", "properties": {}, "additionalProperties": true, "description": "Booqable filter object. Nested operators are encoded as filter[field][operator]." }, "include": { "type": "string", "minLength": 1, "description": "Comma-separated Booqable relationships to sideload." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "Booqable meta aggregation object. Arrays are encoded with bracket query parameters." }, "pageNumber": { "type": "integer", "minimum": 1, "description": "The Booqable page number to request." }, "pageSize": { "type": "integer", "minimum": 1, "description": "The number of Booqable records to request per page." }, "sort": { "type": "string", "minLength": 1, "description": "Booqable sort expression such as created_at or -created_at." } }, "additionalProperties": false, "description": "List Booqable customers." }, "outputSchema": { "type": "object", "properties": { "customers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Booqable resource id." }, "type": { "type": "string", "minLength": 1, "description": "The Booqable JSON:API resource type." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable resource attributes." }, "relationships": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable resource relationships." } }, "additionalProperties": true, "description": "A Booqable JSON:API resource object." }, "description": "Booqable customers resources returned by the request." }, "included": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Booqable resource id." }, "type": { "type": "string", "minLength": 1, "description": "The Booqable JSON:API resource type." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable resource attributes." }, "relationships": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable resource relationships." } }, "additionalProperties": true, "description": "A Booqable JSON:API resource object." }, "description": "JSON:API resources sideloaded by Booqable for this request." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API links returned by Booqable." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API metadata returned by Booqable." } }, "additionalProperties": false, "description": "The Booqable customers list response." } }, { "id": "booqable.list_orders", "service": "booqable", "name": "list_orders", "description": "List Booqable orders with optional fields, filters, includes, and paging.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "fields": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "description": "Comma-separated Booqable field names for one resource type." }, "description": "Booqable fields keyed by resource type, for example { customers: \"id,name\" }." }, "filter": { "type": "object", "properties": {}, "additionalProperties": true, "description": "Booqable filter object. Nested operators are encoded as filter[field][operator]." }, "include": { "type": "string", "minLength": 1, "description": "Comma-separated Booqable relationships to sideload." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "Booqable meta aggregation object. Arrays are encoded with bracket query parameters." }, "pageNumber": { "type": "integer", "minimum": 1, "description": "The Booqable page number to request." }, "pageSize": { "type": "integer", "minimum": 1, "description": "The number of Booqable records to request per page." }, "sort": { "type": "string", "minLength": 1, "description": "Booqable sort expression such as created_at or -created_at." } }, "additionalProperties": false, "description": "List Booqable orders." }, "outputSchema": { "type": "object", "properties": { "orders": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Booqable resource id." }, "type": { "type": "string", "minLength": 1, "description": "The Booqable JSON:API resource type." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable resource attributes." }, "relationships": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable resource relationships." } }, "additionalProperties": true, "description": "A Booqable JSON:API resource object." }, "description": "Booqable orders resources returned by the request." }, "included": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Booqable resource id." }, "type": { "type": "string", "minLength": 1, "description": "The Booqable JSON:API resource type." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable resource attributes." }, "relationships": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable resource relationships." } }, "additionalProperties": true, "description": "A Booqable JSON:API resource object." }, "description": "JSON:API resources sideloaded by Booqable for this request." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API links returned by Booqable." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API metadata returned by Booqable." } }, "additionalProperties": false, "description": "The Booqable orders list response." } }, { "id": "booqable.list_product_groups", "service": "booqable", "name": "list_product_groups", "description": "List Booqable product groups with optional fields, filters, includes, and paging.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "fields": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "description": "Comma-separated Booqable field names for one resource type." }, "description": "Booqable fields keyed by resource type, for example { customers: \"id,name\" }." }, "filter": { "type": "object", "properties": {}, "additionalProperties": true, "description": "Booqable filter object. Nested operators are encoded as filter[field][operator]." }, "include": { "type": "string", "minLength": 1, "description": "Comma-separated Booqable relationships to sideload." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "Booqable meta aggregation object. Arrays are encoded with bracket query parameters." }, "pageNumber": { "type": "integer", "minimum": 1, "description": "The Booqable page number to request." }, "pageSize": { "type": "integer", "minimum": 1, "description": "The number of Booqable records to request per page." }, "sort": { "type": "string", "minLength": 1, "description": "Booqable sort expression such as created_at or -created_at." } }, "additionalProperties": false, "description": "List Booqable product groups." }, "outputSchema": { "type": "object", "properties": { "productGroups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Booqable resource id." }, "type": { "type": "string", "minLength": 1, "description": "The Booqable JSON:API resource type." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable resource attributes." }, "relationships": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable resource relationships." } }, "additionalProperties": true, "description": "A Booqable JSON:API resource object." }, "description": "Booqable productGroups resources returned by the request." }, "included": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Booqable resource id." }, "type": { "type": "string", "minLength": 1, "description": "The Booqable JSON:API resource type." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable resource attributes." }, "relationships": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable resource relationships." } }, "additionalProperties": true, "description": "A Booqable JSON:API resource object." }, "description": "JSON:API resources sideloaded by Booqable for this request." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API links returned by Booqable." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API metadata returned by Booqable." } }, "additionalProperties": false, "description": "The Booqable product groups list response." } }, { "id": "booqable.search_customers", "service": "booqable", "name": "search_customers", "description": "Run a Booqable advanced search over customers.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "search": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable advanced-search JSON body, usually containing filter.conditions and optional fields." } }, "additionalProperties": false, "description": "Advanced search request for a Booqable resource." }, "outputSchema": { "type": "object", "properties": { "customers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Booqable resource id." }, "type": { "type": "string", "minLength": 1, "description": "The Booqable JSON:API resource type." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable resource attributes." }, "relationships": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable resource relationships." } }, "additionalProperties": true, "description": "A Booqable JSON:API resource object." }, "description": "Booqable customers resources returned by the request." }, "included": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Booqable resource id." }, "type": { "type": "string", "minLength": 1, "description": "The Booqable JSON:API resource type." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable resource attributes." }, "relationships": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable resource relationships." } }, "additionalProperties": true, "description": "A Booqable JSON:API resource object." }, "description": "JSON:API resources sideloaded by Booqable for this request." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API links returned by Booqable." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API metadata returned by Booqable." } }, "additionalProperties": false, "description": "The Booqable customers search response." } }, { "id": "booqable.search_orders", "service": "booqable", "name": "search_orders", "description": "Run a Booqable advanced search over orders.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "search": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable advanced-search JSON body, usually containing filter.conditions and optional fields." } }, "additionalProperties": false, "description": "Advanced search request for a Booqable resource." }, "outputSchema": { "type": "object", "properties": { "orders": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Booqable resource id." }, "type": { "type": "string", "minLength": 1, "description": "The Booqable JSON:API resource type." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable resource attributes." }, "relationships": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable resource relationships." } }, "additionalProperties": true, "description": "A Booqable JSON:API resource object." }, "description": "Booqable orders resources returned by the request." }, "included": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Booqable resource id." }, "type": { "type": "string", "minLength": 1, "description": "The Booqable JSON:API resource type." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable resource attributes." }, "relationships": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable resource relationships." } }, "additionalProperties": true, "description": "A Booqable JSON:API resource object." }, "description": "JSON:API resources sideloaded by Booqable for this request." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API links returned by Booqable." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API metadata returned by Booqable." } }, "additionalProperties": false, "description": "The Booqable orders search response." } }, { "id": "booqable.search_product_groups", "service": "booqable", "name": "search_product_groups", "description": "Run a Booqable advanced search over product groups.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "search": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable advanced-search JSON body, usually containing filter.conditions and optional fields." } }, "additionalProperties": false, "description": "Advanced search request for a Booqable resource." }, "outputSchema": { "type": "object", "properties": { "productGroups": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Booqable resource id." }, "type": { "type": "string", "minLength": 1, "description": "The Booqable JSON:API resource type." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable resource attributes." }, "relationships": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable resource relationships." } }, "additionalProperties": true, "description": "A Booqable JSON:API resource object." }, "description": "Booqable productGroups resources returned by the request." }, "included": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "description": "The Booqable resource id." }, "type": { "type": "string", "minLength": 1, "description": "The Booqable JSON:API resource type." }, "attributes": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable resource attributes." }, "relationships": { "type": "object", "properties": {}, "additionalProperties": true, "description": "The Booqable resource relationships." } }, "additionalProperties": true, "description": "A Booqable JSON:API resource object." }, "description": "JSON:API resources sideloaded by Booqable for this request." }, "links": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API links returned by Booqable." }, "meta": { "type": "object", "properties": {}, "additionalProperties": true, "description": "JSON:API metadata returned by Booqable." } }, "additionalProperties": false, "description": "The Booqable product groups search response." } } ] }