{ "service": "kit", "displayName": "Kit", "categories": [ "Marketing", "Communication" ], "authTypes": [ "api_key" ], "auth": [ { "type": "api_key", "label": "API Key", "placeholder": "KIT_API_KEY", "description": "Kit API key sent with the X-Kit-Api-Key request header. Create or copy a personal API key from Kit's developer settings: https://app.kit.com/developer_settings" } ], "homepageUrl": "https://kit.com/", "actions": [ { "id": "kit.create_subscriber", "service": "kit", "name": "create_subscriber", "description": "Create a Kit subscriber, or update the existing subscriber with the same email address.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "email_address": { "type": "string", "description": "Subscriber email address.", "format": "email" }, "first_name": { "anyOf": [ { "type": "string", "description": "Subscriber first name." }, { "type": "null" } ] }, "state": { "type": "string", "enum": [ "active", "inactive", "bounced", "complained", "cancelled", "all" ], "description": "Subscriber status used by Kit." }, "fields": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string", "description": "A custom field value." }, { "type": "null" } ] }, "description": "Custom field values keyed by custom field label. Kit ignores fields that do not exist." } }, "additionalProperties": false, "required": [ "email_address" ], "description": "The input payload for creating or upserting a Kit subscriber." }, "outputSchema": { "type": "object", "properties": { "subscriber": { "type": "object", "properties": { "id": { "type": "integer", "description": "Kit subscriber ID." }, "first_name": { "anyOf": [ { "type": "string", "description": "Subscriber first name." }, { "type": "null" } ] }, "email_address": { "type": "string", "description": "Subscriber email address.", "format": "email" }, "state": { "type": "string", "description": "Subscriber state returned by Kit." }, "created_at": { "type": "string", "description": "Timestamp when the subscriber was created." }, "fields": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string", "description": "A custom field value." }, { "type": "null" } ] }, "description": "Custom field values keyed by custom field label. Kit ignores fields that do not exist." }, "canceled_at": { "anyOf": [ { "type": "string", "description": "Timestamp when the subscriber cancelled, when returned." }, { "type": "null" } ] }, "attribution": { "anyOf": [ { "type": "object", "properties": { "referrer": { "anyOf": [ { "type": "string", "description": "Referrer URL or source." }, { "type": "null" } ] }, "utm_source": { "anyOf": [ { "type": "string", "description": "UTM source value." }, { "type": "null" } ] }, "utm_medium": { "anyOf": [ { "type": "string", "description": "UTM medium value." }, { "type": "null" } ] }, "utm_campaign": { "anyOf": [ { "type": "string", "description": "UTM campaign value." }, { "type": "null" } ] }, "utm_term": { "anyOf": [ { "type": "string", "description": "UTM term value." }, { "type": "null" } ] }, "utm_content": { "anyOf": [ { "type": "string", "description": "UTM content value." }, { "type": "null" } ] }, "source_type": { "anyOf": [ { "type": "string", "description": "Kit source type value." }, { "type": "null" } ] }, "source_name": { "anyOf": [ { "type": "string", "description": "Kit source name value." }, { "type": "null" } ] }, "source_mechanism": { "anyOf": [ { "type": "string", "description": "Kit source mechanism value." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "Subscriber attribution metadata returned by Kit." }, { "type": "null" } ] }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Kit tag ID." }, "name": { "type": "string", "description": "Kit tag name." }, "created_at": { "anyOf": [ { "type": "string", "description": "Timestamp when the tag was created." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "A Kit tag summary." }, "description": "Tags included on the subscriber when requested." }, "location": { "anyOf": [ { "type": "object", "properties": { "city": { "anyOf": [ { "type": "string", "description": "Subscriber city." }, { "type": "null" } ] }, "state": { "anyOf": [ { "type": "string", "description": "Subscriber state or region." }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string", "description": "Subscriber country." }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "type": "number", "description": "Subscriber latitude." }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "number", "description": "Subscriber longitude." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "Subscriber location metadata returned by Kit." }, { "type": "null" } ] }, "added_at": { "anyOf": [ { "type": "string", "description": "Timestamp when the subscriber was added to a form." }, { "type": "null" } ] }, "tagged_at": { "anyOf": [ { "type": "string", "description": "Timestamp when the subscriber was tagged." }, { "type": "null" } ] }, "referrer": { "anyOf": [ { "type": "string", "description": "Referrer returned for a form subscriber." }, { "type": "null" } ] }, "referrer_utm_parameters": { "anyOf": [ { "type": "object", "properties": { "source": { "anyOf": [ { "type": "string", "description": "UTM source value." }, { "type": "null" } ] }, "medium": { "anyOf": [ { "type": "string", "description": "UTM medium value." }, { "type": "null" } ] }, "campaign": { "anyOf": [ { "type": "string", "description": "UTM campaign value." }, { "type": "null" } ] }, "term": { "anyOf": [ { "type": "string", "description": "UTM term value." }, { "type": "null" } ] }, "content": { "anyOf": [ { "type": "string", "description": "UTM content value." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "UTM parameters returned for a form subscriber." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "A Kit subscriber." } }, "additionalProperties": false, "description": "The response returned for a single Kit subscriber." } }, { "id": "kit.get_current_account", "service": "kit", "name": "get_current_account", "description": "Get the current Kit account and authenticated user details.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": {}, "additionalProperties": false, "description": "The input payload for getting the current Kit account." }, "outputSchema": { "type": "object", "properties": { "user": { "type": "object", "properties": { "id": { "anyOf": [ { "type": "integer", "description": "Kit user ID when returned by Kit." }, { "type": "null" } ] }, "email": { "type": "string", "description": "Authenticated Kit user email address.", "format": "email" } }, "additionalProperties": false, "description": "Authenticated Kit user details." }, "account": { "type": "object", "properties": { "id": { "type": "integer", "description": "Kit account ID." }, "name": { "type": "string", "description": "Kit account name." }, "plan_type": { "type": "string", "description": "Kit plan type for the account." }, "primary_email_address": { "type": "string", "description": "Primary email address for the account.", "format": "email" }, "created_at": { "type": "string", "description": "Timestamp when the account was created." }, "timezone": { "type": "object", "properties": { "name": { "type": "string", "description": "IANA timezone name configured for the Kit account." }, "friendly_name": { "type": "string", "description": "Human-readable timezone name returned by Kit." }, "utc_offset": { "type": "string", "description": "UTC offset returned by Kit." } }, "additionalProperties": false, "description": "Kit account timezone metadata." }, "sending_addresses": { "type": "array", "items": { "type": "object", "properties": { "email_address": { "type": "string", "description": "Sending email address.", "format": "email" }, "from_name": { "type": "string", "description": "Display name used for the sending address." }, "status": { "type": "string", "description": "Verification status of the sending address." }, "is_default": { "type": "boolean", "description": "Whether this is the default sending address." }, "is_verified": { "type": "boolean", "description": "Whether Kit has verified this sending address." }, "is_dmarc_configured": { "type": "boolean", "description": "Whether DMARC is configured for the sending domain." } }, "additionalProperties": false, "description": "A Kit sending address." }, "description": "Sending addresses configured for the account." } }, "additionalProperties": false, "description": "Kit account details." } }, "additionalProperties": false, "description": "The response returned when getting the current Kit account." } }, { "id": "kit.get_subscriber", "service": "kit", "name": "get_subscriber", "description": "Get one Kit subscriber by ID.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "description": "Kit subscriber ID." } }, "additionalProperties": false, "description": "The input payload for getting a Kit subscriber." }, "outputSchema": { "type": "object", "properties": { "subscriber": { "type": "object", "properties": { "id": { "type": "integer", "description": "Kit subscriber ID." }, "first_name": { "anyOf": [ { "type": "string", "description": "Subscriber first name." }, { "type": "null" } ] }, "email_address": { "type": "string", "description": "Subscriber email address.", "format": "email" }, "state": { "type": "string", "description": "Subscriber state returned by Kit." }, "created_at": { "type": "string", "description": "Timestamp when the subscriber was created." }, "fields": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string", "description": "A custom field value." }, { "type": "null" } ] }, "description": "Custom field values keyed by custom field label. Kit ignores fields that do not exist." }, "canceled_at": { "anyOf": [ { "type": "string", "description": "Timestamp when the subscriber cancelled, when returned." }, { "type": "null" } ] }, "attribution": { "anyOf": [ { "type": "object", "properties": { "referrer": { "anyOf": [ { "type": "string", "description": "Referrer URL or source." }, { "type": "null" } ] }, "utm_source": { "anyOf": [ { "type": "string", "description": "UTM source value." }, { "type": "null" } ] }, "utm_medium": { "anyOf": [ { "type": "string", "description": "UTM medium value." }, { "type": "null" } ] }, "utm_campaign": { "anyOf": [ { "type": "string", "description": "UTM campaign value." }, { "type": "null" } ] }, "utm_term": { "anyOf": [ { "type": "string", "description": "UTM term value." }, { "type": "null" } ] }, "utm_content": { "anyOf": [ { "type": "string", "description": "UTM content value." }, { "type": "null" } ] }, "source_type": { "anyOf": [ { "type": "string", "description": "Kit source type value." }, { "type": "null" } ] }, "source_name": { "anyOf": [ { "type": "string", "description": "Kit source name value." }, { "type": "null" } ] }, "source_mechanism": { "anyOf": [ { "type": "string", "description": "Kit source mechanism value." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "Subscriber attribution metadata returned by Kit." }, { "type": "null" } ] }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Kit tag ID." }, "name": { "type": "string", "description": "Kit tag name." }, "created_at": { "anyOf": [ { "type": "string", "description": "Timestamp when the tag was created." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "A Kit tag summary." }, "description": "Tags included on the subscriber when requested." }, "location": { "anyOf": [ { "type": "object", "properties": { "city": { "anyOf": [ { "type": "string", "description": "Subscriber city." }, { "type": "null" } ] }, "state": { "anyOf": [ { "type": "string", "description": "Subscriber state or region." }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string", "description": "Subscriber country." }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "type": "number", "description": "Subscriber latitude." }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "number", "description": "Subscriber longitude." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "Subscriber location metadata returned by Kit." }, { "type": "null" } ] }, "added_at": { "anyOf": [ { "type": "string", "description": "Timestamp when the subscriber was added to a form." }, { "type": "null" } ] }, "tagged_at": { "anyOf": [ { "type": "string", "description": "Timestamp when the subscriber was tagged." }, { "type": "null" } ] }, "referrer": { "anyOf": [ { "type": "string", "description": "Referrer returned for a form subscriber." }, { "type": "null" } ] }, "referrer_utm_parameters": { "anyOf": [ { "type": "object", "properties": { "source": { "anyOf": [ { "type": "string", "description": "UTM source value." }, { "type": "null" } ] }, "medium": { "anyOf": [ { "type": "string", "description": "UTM medium value." }, { "type": "null" } ] }, "campaign": { "anyOf": [ { "type": "string", "description": "UTM campaign value." }, { "type": "null" } ] }, "term": { "anyOf": [ { "type": "string", "description": "UTM term value." }, { "type": "null" } ] }, "content": { "anyOf": [ { "type": "string", "description": "UTM content value." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "UTM parameters returned for a form subscriber." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "A Kit subscriber." } }, "additionalProperties": false, "description": "The response returned for a single Kit subscriber." } }, { "id": "kit.list_form_subscribers", "service": "kit", "name": "list_form_subscribers", "description": "List Kit subscribers who joined through a specific form.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "form_id": { "type": "integer", "minimum": 1, "description": "Kit form ID." }, "after": { "type": "string", "minLength": 1, "description": "Cursor returned by Kit pagination." }, "before": { "type": "string", "minLength": 1, "description": "Cursor returned by Kit pagination." }, "per_page": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "Number of records to return per page. Kit defaults to 500." }, "include_total_count": { "type": "boolean", "description": "Whether Kit should include the total_count value in pagination metadata." }, "added_after": { "type": "string", "minLength": 1, "description": "Date or timestamp used by Kit filter parameters." }, "added_before": { "type": "string", "minLength": 1, "description": "Date or timestamp used by Kit filter parameters." }, "created_after": { "type": "string", "minLength": 1, "description": "Date or timestamp used by Kit filter parameters." }, "created_before": { "type": "string", "minLength": 1, "description": "Date or timestamp used by Kit filter parameters." }, "status": { "type": "string", "enum": [ "active", "inactive", "bounced", "complained", "cancelled", "all" ], "description": "Subscriber status used by Kit." } }, "additionalProperties": false, "required": [ "form_id" ], "description": "The input payload for listing subscribers for a Kit form." }, "outputSchema": { "type": "object", "properties": { "subscribers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Kit subscriber ID." }, "first_name": { "anyOf": [ { "type": "string", "description": "Subscriber first name." }, { "type": "null" } ] }, "email_address": { "type": "string", "description": "Subscriber email address.", "format": "email" }, "state": { "type": "string", "description": "Subscriber state returned by Kit." }, "created_at": { "type": "string", "description": "Timestamp when the subscriber was created." }, "fields": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string", "description": "A custom field value." }, { "type": "null" } ] }, "description": "Custom field values keyed by custom field label. Kit ignores fields that do not exist." }, "canceled_at": { "anyOf": [ { "type": "string", "description": "Timestamp when the subscriber cancelled, when returned." }, { "type": "null" } ] }, "attribution": { "anyOf": [ { "type": "object", "properties": { "referrer": { "anyOf": [ { "type": "string", "description": "Referrer URL or source." }, { "type": "null" } ] }, "utm_source": { "anyOf": [ { "type": "string", "description": "UTM source value." }, { "type": "null" } ] }, "utm_medium": { "anyOf": [ { "type": "string", "description": "UTM medium value." }, { "type": "null" } ] }, "utm_campaign": { "anyOf": [ { "type": "string", "description": "UTM campaign value." }, { "type": "null" } ] }, "utm_term": { "anyOf": [ { "type": "string", "description": "UTM term value." }, { "type": "null" } ] }, "utm_content": { "anyOf": [ { "type": "string", "description": "UTM content value." }, { "type": "null" } ] }, "source_type": { "anyOf": [ { "type": "string", "description": "Kit source type value." }, { "type": "null" } ] }, "source_name": { "anyOf": [ { "type": "string", "description": "Kit source name value." }, { "type": "null" } ] }, "source_mechanism": { "anyOf": [ { "type": "string", "description": "Kit source mechanism value." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "Subscriber attribution metadata returned by Kit." }, { "type": "null" } ] }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Kit tag ID." }, "name": { "type": "string", "description": "Kit tag name." }, "created_at": { "anyOf": [ { "type": "string", "description": "Timestamp when the tag was created." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "A Kit tag summary." }, "description": "Tags included on the subscriber when requested." }, "location": { "anyOf": [ { "type": "object", "properties": { "city": { "anyOf": [ { "type": "string", "description": "Subscriber city." }, { "type": "null" } ] }, "state": { "anyOf": [ { "type": "string", "description": "Subscriber state or region." }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string", "description": "Subscriber country." }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "type": "number", "description": "Subscriber latitude." }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "number", "description": "Subscriber longitude." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "Subscriber location metadata returned by Kit." }, { "type": "null" } ] }, "added_at": { "anyOf": [ { "type": "string", "description": "Timestamp when the subscriber was added to a form." }, { "type": "null" } ] }, "tagged_at": { "anyOf": [ { "type": "string", "description": "Timestamp when the subscriber was tagged." }, { "type": "null" } ] }, "referrer": { "anyOf": [ { "type": "string", "description": "Referrer returned for a form subscriber." }, { "type": "null" } ] }, "referrer_utm_parameters": { "anyOf": [ { "type": "object", "properties": { "source": { "anyOf": [ { "type": "string", "description": "UTM source value." }, { "type": "null" } ] }, "medium": { "anyOf": [ { "type": "string", "description": "UTM medium value." }, { "type": "null" } ] }, "campaign": { "anyOf": [ { "type": "string", "description": "UTM campaign value." }, { "type": "null" } ] }, "term": { "anyOf": [ { "type": "string", "description": "UTM term value." }, { "type": "null" } ] }, "content": { "anyOf": [ { "type": "string", "description": "UTM content value." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "UTM parameters returned for a form subscriber." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "A Kit subscriber." }, "description": "Kit subscribers returned by the request." }, "pagination": { "type": "object", "properties": { "has_previous_page": { "type": "boolean", "description": "Whether a previous page exists." }, "has_next_page": { "type": "boolean", "description": "Whether a next page exists." }, "start_cursor": { "anyOf": [ { "type": "string", "description": "Cursor for the first item on the current page." }, { "type": "null" } ] }, "end_cursor": { "anyOf": [ { "type": "string", "description": "Cursor for the last item on the current page." }, { "type": "null" } ] }, "per_page": { "type": "integer", "description": "Number of records returned per page." }, "total_count": { "anyOf": [ { "type": "integer", "description": "Total count when requested and returned by Kit." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "Kit pagination metadata." } }, "additionalProperties": false, "description": "The response returned when listing Kit subscribers." } }, { "id": "kit.list_forms", "service": "kit", "name": "list_forms", "description": "List Kit forms and landing pages with optional filters and pagination.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "after": { "type": "string", "minLength": 1, "description": "Cursor returned by Kit pagination." }, "before": { "type": "string", "minLength": 1, "description": "Cursor returned by Kit pagination." }, "per_page": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "Number of records to return per page. Kit defaults to 500." }, "include_total_count": { "type": "boolean", "description": "Whether Kit should include the total_count value in pagination metadata." }, "status": { "type": "string", "enum": [ "active", "archived", "trashed", "all" ], "description": "Form status used by Kit." }, "type": { "type": "string", "enum": [ "embed", "hosted" ], "description": "Kit form type." } }, "additionalProperties": false, "description": "The input payload for listing Kit forms." }, "outputSchema": { "type": "object", "properties": { "forms": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Kit form ID." }, "name": { "type": "string", "description": "Kit form name." }, "created_at": { "type": "string", "description": "Timestamp when the form was created." }, "type": { "type": "string", "description": "Form type returned by Kit." }, "format": { "anyOf": [ { "type": "string", "description": "Form format returned by Kit." }, { "type": "null" } ] }, "embed_js": { "type": "string", "description": "URL for the form embed JavaScript." }, "embed_url": { "type": "string", "description": "URL for the hosted form.", "format": "uri" }, "archived": { "type": "boolean", "description": "Whether the form is archived." }, "uid": { "type": "string", "description": "Kit form UID." } }, "additionalProperties": false, "description": "A Kit form or landing page." }, "description": "Kit forms returned by the request." }, "pagination": { "type": "object", "properties": { "has_previous_page": { "type": "boolean", "description": "Whether a previous page exists." }, "has_next_page": { "type": "boolean", "description": "Whether a next page exists." }, "start_cursor": { "anyOf": [ { "type": "string", "description": "Cursor for the first item on the current page." }, { "type": "null" } ] }, "end_cursor": { "anyOf": [ { "type": "string", "description": "Cursor for the last item on the current page." }, { "type": "null" } ] }, "per_page": { "type": "integer", "description": "Number of records returned per page." }, "total_count": { "anyOf": [ { "type": "integer", "description": "Total count when requested and returned by Kit." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "Kit pagination metadata." } }, "additionalProperties": false, "description": "The response returned when listing Kit forms." } }, { "id": "kit.list_subscribers", "service": "kit", "name": "list_subscribers", "description": "List Kit subscribers with optional filtering, sorting, and pagination.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "after": { "type": "string", "minLength": 1, "description": "Cursor returned by Kit pagination." }, "before": { "type": "string", "minLength": 1, "description": "Cursor returned by Kit pagination." }, "per_page": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "Number of records to return per page. Kit defaults to 500." }, "include_total_count": { "type": "boolean", "description": "Whether Kit should include the total_count value in pagination metadata." }, "created_after": { "type": "string", "minLength": 1, "description": "Date or timestamp used by Kit filter parameters." }, "created_before": { "type": "string", "minLength": 1, "description": "Date or timestamp used by Kit filter parameters." }, "updated_after": { "type": "string", "minLength": 1, "description": "Date or timestamp used by Kit filter parameters." }, "updated_before": { "type": "string", "minLength": 1, "description": "Date or timestamp used by Kit filter parameters." }, "email_address": { "type": "string", "description": "Exact subscriber email address or comma-separated emails." }, "include": { "type": "array", "items": { "type": "string", "enum": [ "attribution", "tags", "location", "canceled_at" ], "description": "One supported Kit subscriber include value." }, "description": "Additional subscriber fields to include in Kit list responses.", "minItems": 1 }, "sort_field": { "type": "string", "enum": [ "id", "cancelled_at", "updated_at" ], "description": "Subscriber field used for sorting." }, "sort_order": { "type": "string", "enum": [ "asc", "desc" ], "description": "Sort direction used by Kit." }, "status": { "type": "string", "enum": [ "active", "inactive", "bounced", "complained", "cancelled", "all" ], "description": "Subscriber status used by Kit." } }, "additionalProperties": false, "description": "The input payload for listing Kit subscribers." }, "outputSchema": { "type": "object", "properties": { "subscribers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Kit subscriber ID." }, "first_name": { "anyOf": [ { "type": "string", "description": "Subscriber first name." }, { "type": "null" } ] }, "email_address": { "type": "string", "description": "Subscriber email address.", "format": "email" }, "state": { "type": "string", "description": "Subscriber state returned by Kit." }, "created_at": { "type": "string", "description": "Timestamp when the subscriber was created." }, "fields": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string", "description": "A custom field value." }, { "type": "null" } ] }, "description": "Custom field values keyed by custom field label. Kit ignores fields that do not exist." }, "canceled_at": { "anyOf": [ { "type": "string", "description": "Timestamp when the subscriber cancelled, when returned." }, { "type": "null" } ] }, "attribution": { "anyOf": [ { "type": "object", "properties": { "referrer": { "anyOf": [ { "type": "string", "description": "Referrer URL or source." }, { "type": "null" } ] }, "utm_source": { "anyOf": [ { "type": "string", "description": "UTM source value." }, { "type": "null" } ] }, "utm_medium": { "anyOf": [ { "type": "string", "description": "UTM medium value." }, { "type": "null" } ] }, "utm_campaign": { "anyOf": [ { "type": "string", "description": "UTM campaign value." }, { "type": "null" } ] }, "utm_term": { "anyOf": [ { "type": "string", "description": "UTM term value." }, { "type": "null" } ] }, "utm_content": { "anyOf": [ { "type": "string", "description": "UTM content value." }, { "type": "null" } ] }, "source_type": { "anyOf": [ { "type": "string", "description": "Kit source type value." }, { "type": "null" } ] }, "source_name": { "anyOf": [ { "type": "string", "description": "Kit source name value." }, { "type": "null" } ] }, "source_mechanism": { "anyOf": [ { "type": "string", "description": "Kit source mechanism value." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "Subscriber attribution metadata returned by Kit." }, { "type": "null" } ] }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Kit tag ID." }, "name": { "type": "string", "description": "Kit tag name." }, "created_at": { "anyOf": [ { "type": "string", "description": "Timestamp when the tag was created." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "A Kit tag summary." }, "description": "Tags included on the subscriber when requested." }, "location": { "anyOf": [ { "type": "object", "properties": { "city": { "anyOf": [ { "type": "string", "description": "Subscriber city." }, { "type": "null" } ] }, "state": { "anyOf": [ { "type": "string", "description": "Subscriber state or region." }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string", "description": "Subscriber country." }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "type": "number", "description": "Subscriber latitude." }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "number", "description": "Subscriber longitude." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "Subscriber location metadata returned by Kit." }, { "type": "null" } ] }, "added_at": { "anyOf": [ { "type": "string", "description": "Timestamp when the subscriber was added to a form." }, { "type": "null" } ] }, "tagged_at": { "anyOf": [ { "type": "string", "description": "Timestamp when the subscriber was tagged." }, { "type": "null" } ] }, "referrer": { "anyOf": [ { "type": "string", "description": "Referrer returned for a form subscriber." }, { "type": "null" } ] }, "referrer_utm_parameters": { "anyOf": [ { "type": "object", "properties": { "source": { "anyOf": [ { "type": "string", "description": "UTM source value." }, { "type": "null" } ] }, "medium": { "anyOf": [ { "type": "string", "description": "UTM medium value." }, { "type": "null" } ] }, "campaign": { "anyOf": [ { "type": "string", "description": "UTM campaign value." }, { "type": "null" } ] }, "term": { "anyOf": [ { "type": "string", "description": "UTM term value." }, { "type": "null" } ] }, "content": { "anyOf": [ { "type": "string", "description": "UTM content value." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "UTM parameters returned for a form subscriber." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "A Kit subscriber." }, "description": "Kit subscribers returned by the request." }, "pagination": { "type": "object", "properties": { "has_previous_page": { "type": "boolean", "description": "Whether a previous page exists." }, "has_next_page": { "type": "boolean", "description": "Whether a next page exists." }, "start_cursor": { "anyOf": [ { "type": "string", "description": "Cursor for the first item on the current page." }, { "type": "null" } ] }, "end_cursor": { "anyOf": [ { "type": "string", "description": "Cursor for the last item on the current page." }, { "type": "null" } ] }, "per_page": { "type": "integer", "description": "Number of records returned per page." }, "total_count": { "anyOf": [ { "type": "integer", "description": "Total count when requested and returned by Kit." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "Kit pagination metadata." } }, "additionalProperties": false, "description": "The response returned when listing Kit subscribers." } }, { "id": "kit.list_tag_subscribers", "service": "kit", "name": "list_tag_subscribers", "description": "List Kit subscribers who have a specific tag.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "tag_id": { "type": "integer", "minimum": 1, "description": "Kit tag ID." }, "after": { "type": "string", "minLength": 1, "description": "Cursor returned by Kit pagination." }, "before": { "type": "string", "minLength": 1, "description": "Cursor returned by Kit pagination." }, "per_page": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "Number of records to return per page. Kit defaults to 500." }, "include_total_count": { "type": "boolean", "description": "Whether Kit should include the total_count value in pagination metadata." }, "created_after": { "type": "string", "minLength": 1, "description": "Date or timestamp used by Kit filter parameters." }, "created_before": { "type": "string", "minLength": 1, "description": "Date or timestamp used by Kit filter parameters." }, "tagged_after": { "type": "string", "minLength": 1, "description": "Date or timestamp used by Kit filter parameters." }, "tagged_before": { "type": "string", "minLength": 1, "description": "Date or timestamp used by Kit filter parameters." }, "status": { "type": "string", "enum": [ "active", "inactive", "bounced", "complained", "cancelled", "all" ], "description": "Subscriber status used by Kit." } }, "additionalProperties": false, "required": [ "tag_id" ], "description": "The input payload for listing subscribers for a Kit tag." }, "outputSchema": { "type": "object", "properties": { "subscribers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Kit subscriber ID." }, "first_name": { "anyOf": [ { "type": "string", "description": "Subscriber first name." }, { "type": "null" } ] }, "email_address": { "type": "string", "description": "Subscriber email address.", "format": "email" }, "state": { "type": "string", "description": "Subscriber state returned by Kit." }, "created_at": { "type": "string", "description": "Timestamp when the subscriber was created." }, "fields": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string", "description": "A custom field value." }, { "type": "null" } ] }, "description": "Custom field values keyed by custom field label. Kit ignores fields that do not exist." }, "canceled_at": { "anyOf": [ { "type": "string", "description": "Timestamp when the subscriber cancelled, when returned." }, { "type": "null" } ] }, "attribution": { "anyOf": [ { "type": "object", "properties": { "referrer": { "anyOf": [ { "type": "string", "description": "Referrer URL or source." }, { "type": "null" } ] }, "utm_source": { "anyOf": [ { "type": "string", "description": "UTM source value." }, { "type": "null" } ] }, "utm_medium": { "anyOf": [ { "type": "string", "description": "UTM medium value." }, { "type": "null" } ] }, "utm_campaign": { "anyOf": [ { "type": "string", "description": "UTM campaign value." }, { "type": "null" } ] }, "utm_term": { "anyOf": [ { "type": "string", "description": "UTM term value." }, { "type": "null" } ] }, "utm_content": { "anyOf": [ { "type": "string", "description": "UTM content value." }, { "type": "null" } ] }, "source_type": { "anyOf": [ { "type": "string", "description": "Kit source type value." }, { "type": "null" } ] }, "source_name": { "anyOf": [ { "type": "string", "description": "Kit source name value." }, { "type": "null" } ] }, "source_mechanism": { "anyOf": [ { "type": "string", "description": "Kit source mechanism value." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "Subscriber attribution metadata returned by Kit." }, { "type": "null" } ] }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Kit tag ID." }, "name": { "type": "string", "description": "Kit tag name." }, "created_at": { "anyOf": [ { "type": "string", "description": "Timestamp when the tag was created." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "A Kit tag summary." }, "description": "Tags included on the subscriber when requested." }, "location": { "anyOf": [ { "type": "object", "properties": { "city": { "anyOf": [ { "type": "string", "description": "Subscriber city." }, { "type": "null" } ] }, "state": { "anyOf": [ { "type": "string", "description": "Subscriber state or region." }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string", "description": "Subscriber country." }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "type": "number", "description": "Subscriber latitude." }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "number", "description": "Subscriber longitude." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "Subscriber location metadata returned by Kit." }, { "type": "null" } ] }, "added_at": { "anyOf": [ { "type": "string", "description": "Timestamp when the subscriber was added to a form." }, { "type": "null" } ] }, "tagged_at": { "anyOf": [ { "type": "string", "description": "Timestamp when the subscriber was tagged." }, { "type": "null" } ] }, "referrer": { "anyOf": [ { "type": "string", "description": "Referrer returned for a form subscriber." }, { "type": "null" } ] }, "referrer_utm_parameters": { "anyOf": [ { "type": "object", "properties": { "source": { "anyOf": [ { "type": "string", "description": "UTM source value." }, { "type": "null" } ] }, "medium": { "anyOf": [ { "type": "string", "description": "UTM medium value." }, { "type": "null" } ] }, "campaign": { "anyOf": [ { "type": "string", "description": "UTM campaign value." }, { "type": "null" } ] }, "term": { "anyOf": [ { "type": "string", "description": "UTM term value." }, { "type": "null" } ] }, "content": { "anyOf": [ { "type": "string", "description": "UTM content value." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "UTM parameters returned for a form subscriber." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "A Kit subscriber." }, "description": "Kit subscribers returned by the request." }, "pagination": { "type": "object", "properties": { "has_previous_page": { "type": "boolean", "description": "Whether a previous page exists." }, "has_next_page": { "type": "boolean", "description": "Whether a next page exists." }, "start_cursor": { "anyOf": [ { "type": "string", "description": "Cursor for the first item on the current page." }, { "type": "null" } ] }, "end_cursor": { "anyOf": [ { "type": "string", "description": "Cursor for the last item on the current page." }, { "type": "null" } ] }, "per_page": { "type": "integer", "description": "Number of records returned per page." }, "total_count": { "anyOf": [ { "type": "integer", "description": "Total count when requested and returned by Kit." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "Kit pagination metadata." } }, "additionalProperties": false, "description": "The response returned when listing Kit subscribers." } }, { "id": "kit.list_tags", "service": "kit", "name": "list_tags", "description": "List Kit tags with optional pagination.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "after": { "type": "string", "minLength": 1, "description": "Cursor returned by Kit pagination." }, "before": { "type": "string", "minLength": 1, "description": "Cursor returned by Kit pagination." }, "per_page": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "Number of records to return per page. Kit defaults to 500." }, "include_total_count": { "type": "boolean", "description": "Whether Kit should include the total_count value in pagination metadata." } }, "additionalProperties": false, "description": "The input payload for listing Kit tags." }, "outputSchema": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Kit tag ID." }, "name": { "type": "string", "description": "Kit tag name." }, "created_at": { "anyOf": [ { "type": "string", "description": "Timestamp when the tag was created." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "A Kit tag summary." }, "description": "Kit tags returned by the request." }, "pagination": { "type": "object", "properties": { "has_previous_page": { "type": "boolean", "description": "Whether a previous page exists." }, "has_next_page": { "type": "boolean", "description": "Whether a next page exists." }, "start_cursor": { "anyOf": [ { "type": "string", "description": "Cursor for the first item on the current page." }, { "type": "null" } ] }, "end_cursor": { "anyOf": [ { "type": "string", "description": "Cursor for the last item on the current page." }, { "type": "null" } ] }, "per_page": { "type": "integer", "description": "Number of records returned per page." }, "total_count": { "anyOf": [ { "type": "integer", "description": "Total count when requested and returned by Kit." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "Kit pagination metadata." } }, "additionalProperties": false, "description": "The response returned when listing Kit tags." } }, { "id": "kit.update_subscriber", "service": "kit", "name": "update_subscriber", "description": "Update a Kit subscriber's email address, first name, and custom fields.", "requiredScopes": [], "providerPermissions": [], "inputSchema": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 1, "description": "Kit subscriber ID." }, "email_address": { "type": "string", "description": "Subscriber email address.", "format": "email" }, "first_name": { "anyOf": [ { "type": "string", "description": "Subscriber first name." }, { "type": "null" } ] }, "fields": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string", "description": "A custom field value." }, { "type": "null" } ] }, "description": "Custom field values keyed by custom field label. Kit ignores fields that do not exist." } }, "additionalProperties": false, "required": [ "id", "email_address" ], "description": "The input payload for updating a Kit subscriber." }, "outputSchema": { "type": "object", "properties": { "subscriber": { "type": "object", "properties": { "id": { "type": "integer", "description": "Kit subscriber ID." }, "first_name": { "anyOf": [ { "type": "string", "description": "Subscriber first name." }, { "type": "null" } ] }, "email_address": { "type": "string", "description": "Subscriber email address.", "format": "email" }, "state": { "type": "string", "description": "Subscriber state returned by Kit." }, "created_at": { "type": "string", "description": "Timestamp when the subscriber was created." }, "fields": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string", "description": "A custom field value." }, { "type": "null" } ] }, "description": "Custom field values keyed by custom field label. Kit ignores fields that do not exist." }, "canceled_at": { "anyOf": [ { "type": "string", "description": "Timestamp when the subscriber cancelled, when returned." }, { "type": "null" } ] }, "attribution": { "anyOf": [ { "type": "object", "properties": { "referrer": { "anyOf": [ { "type": "string", "description": "Referrer URL or source." }, { "type": "null" } ] }, "utm_source": { "anyOf": [ { "type": "string", "description": "UTM source value." }, { "type": "null" } ] }, "utm_medium": { "anyOf": [ { "type": "string", "description": "UTM medium value." }, { "type": "null" } ] }, "utm_campaign": { "anyOf": [ { "type": "string", "description": "UTM campaign value." }, { "type": "null" } ] }, "utm_term": { "anyOf": [ { "type": "string", "description": "UTM term value." }, { "type": "null" } ] }, "utm_content": { "anyOf": [ { "type": "string", "description": "UTM content value." }, { "type": "null" } ] }, "source_type": { "anyOf": [ { "type": "string", "description": "Kit source type value." }, { "type": "null" } ] }, "source_name": { "anyOf": [ { "type": "string", "description": "Kit source name value." }, { "type": "null" } ] }, "source_mechanism": { "anyOf": [ { "type": "string", "description": "Kit source mechanism value." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "Subscriber attribution metadata returned by Kit." }, { "type": "null" } ] }, "tags": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "Kit tag ID." }, "name": { "type": "string", "description": "Kit tag name." }, "created_at": { "anyOf": [ { "type": "string", "description": "Timestamp when the tag was created." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "A Kit tag summary." }, "description": "Tags included on the subscriber when requested." }, "location": { "anyOf": [ { "type": "object", "properties": { "city": { "anyOf": [ { "type": "string", "description": "Subscriber city." }, { "type": "null" } ] }, "state": { "anyOf": [ { "type": "string", "description": "Subscriber state or region." }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string", "description": "Subscriber country." }, { "type": "null" } ] }, "latitude": { "anyOf": [ { "type": "number", "description": "Subscriber latitude." }, { "type": "null" } ] }, "longitude": { "anyOf": [ { "type": "number", "description": "Subscriber longitude." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "Subscriber location metadata returned by Kit." }, { "type": "null" } ] }, "added_at": { "anyOf": [ { "type": "string", "description": "Timestamp when the subscriber was added to a form." }, { "type": "null" } ] }, "tagged_at": { "anyOf": [ { "type": "string", "description": "Timestamp when the subscriber was tagged." }, { "type": "null" } ] }, "referrer": { "anyOf": [ { "type": "string", "description": "Referrer returned for a form subscriber." }, { "type": "null" } ] }, "referrer_utm_parameters": { "anyOf": [ { "type": "object", "properties": { "source": { "anyOf": [ { "type": "string", "description": "UTM source value." }, { "type": "null" } ] }, "medium": { "anyOf": [ { "type": "string", "description": "UTM medium value." }, { "type": "null" } ] }, "campaign": { "anyOf": [ { "type": "string", "description": "UTM campaign value." }, { "type": "null" } ] }, "term": { "anyOf": [ { "type": "string", "description": "UTM term value." }, { "type": "null" } ] }, "content": { "anyOf": [ { "type": "string", "description": "UTM content value." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "UTM parameters returned for a form subscriber." }, { "type": "null" } ] } }, "additionalProperties": false, "description": "A Kit subscriber." } }, "additionalProperties": false, "description": "The response returned for a single Kit subscriber." } } ] }