/userflow | Type: Application | PCID required: Yes
Tools
userflow_create_invite
Create an invite Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
account_id | string | Yes | — | Unique identifier for the account |
email | string | Yes | — | Email address |
name | string | Yes | — | Name of the invited person |
permissions | object[] | No | — | Intended permissions. Use * for subject_id to assign publish_flow for all environments. |
role | string | Yes | — | Intended role for the invitee |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "string",
"description": "Unique identifier for the account"
},
"email": {
"type": "string",
"description": "Email address"
},
"name": {
"type": "string",
"description": "Name of the invited person"
},
"permissions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"action": {
"type": "string",
"description": "The action value"
},
"subject": {
"type": "string",
"description": "The subject value"
},
"subject_id": {
"type": "string",
"description": "Subject Id"
}
}
},
"description": "Intended permissions. Use * for subject_id to assign publish_flow for all environments."
},
"role": {
"type": "string",
"description": "Intended role for the invitee",
"enum": [
"admin",
"editor",
"viewer"
]
}
},
"required": [
"PCID",
"account_id",
"email",
"name",
"role"
]
}
userflow_create_or_update_group
Create or update a group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string | No | — | Expand related objects (e.g. memberships, memberships.user, users) |
attributes | object | No | — | Map of attributes to set or update. Values can be literals, null, or operation objects. |
id | string | Yes | — | Unique identifier for the group. Should match the ID in your database. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"expand": {
"type": "string",
"description": "Expand related objects (e.g. memberships, memberships.user, users)"
},
"attributes": {
"type": "object",
"description": "Map of attributes to set or update. Values can be literals, null, or operation objects."
},
"id": {
"type": "string",
"description": "Unique identifier for the group. Should match the ID in your database."
}
},
"required": [
"PCID",
"id"
]
}
userflow_create_or_update_user
Create or update a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string | No | — | Expand related objects in the response (e.g. groups, memberships, memberships.group) |
attributes | object | No | — | Map of attributes to set or update. Existing attributes not included are untouched. Values can be literals, null (to unset), or operation objects. |
groups | object[] | No | — | Groups to update and ensure user membership. Cannot be used with memberships. |
id | string | Yes | — | Unique identifier for the user. Should match the ID in your database. |
memberships | object[] | No | — | Group memberships to create/update. Each must include embedded group object with at least id. Cannot be used with groups. |
prune_memberships | boolean | No | — | If true, removes memberships not included in request. Default: false. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"expand": {
"type": "string",
"description": "Expand related objects in the response (e.g. groups, memberships, memberships.group)"
},
"attributes": {
"type": "object",
"description": "Map of attributes to set or update. Existing attributes not included are untouched. Values can be literals, null (to unset), or operation objects."
},
"groups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Group ID"
},
"attributes": {
"type": "object",
"description": "Group attributes to set"
}
},
"required": [
"id"
]
},
"description": "Groups to update and ensure user membership. Cannot be used with memberships."
},
"id": {
"type": "string",
"description": "Unique identifier for the user. Should match the ID in your database."
},
"memberships": {
"type": "array",
"items": {
"type": "object",
"properties": {
"attributes": {
"type": "object",
"description": "Membership attributes (e.g. role)"
},
"group": {
"type": "object",
"description": "The group value"
}
}
},
"description": "Group memberships to create/update. Each must include embedded group object with at least id. Cannot be used with groups."
},
"prune_memberships": {
"type": "boolean",
"description": "If true, removes memberships not included in request. Default: false."
}
},
"required": [
"PCID",
"id"
]
}
userflow_create_webhook_subscription
Create a webhook subscription Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
api_version | string | No | — | API version for notifications |
topics | string[] | Yes | — | Webhook topics to subscribe to (e.g. user, event, group, user.created, event.tracked) |
url | string | Yes | — | URL for POST notifications |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"api_version": {
"type": "string",
"description": "API version for notifications"
},
"topics": {
"type": "array",
"items": {
"type": "string"
},
"description": "Webhook topics to subscribe to (e.g. user, event, group, user.created, event.tracked)"
},
"url": {
"type": "string",
"description": "URL for POST notifications"
}
},
"required": [
"PCID",
"topics",
"url"
]
}
userflow_delete_content_session
Delete a content session Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
session_id | string | Yes | — | Unique identifier for the content session |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"session_id": {
"type": "string",
"description": "Unique identifier for the content session"
}
},
"required": [
"PCID",
"session_id"
]
}
userflow_delete_group
Delete a group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
group_id | string | Yes | — | Unique identifier for the group |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"group_id": {
"type": "string",
"description": "Unique identifier for the group"
}
},
"required": [
"PCID",
"group_id"
]
}
userflow_delete_invite
Delete an invite Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
account_id | string | Yes | — | Unique identifier for the account |
invite_id | string | Yes | — | Unique identifier for the invite |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "string",
"description": "Unique identifier for the account"
},
"invite_id": {
"type": "string",
"description": "Unique identifier for the invite"
}
},
"required": [
"PCID",
"account_id",
"invite_id"
]
}
userflow_delete_user
Delete a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
user_id | string | Yes | — | Unique identifier for the user |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"user_id": {
"type": "string",
"description": "Unique identifier for the user"
}
},
"required": [
"PCID",
"user_id"
]
}
userflow_delete_webhook_subscription
Delete a webhook subscription Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
webhook_subscription_id | string | Yes | — | ID of the webhook subscription |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"webhook_subscription_id": {
"type": "string",
"description": "ID of the webhook subscription"
}
},
"required": [
"PCID",
"webhook_subscription_id"
]
}
userflow_end_content_session
End a content session Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
content_session_id | string | Yes | — | ID of the content session to end |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"content_session_id": {
"type": "string",
"description": "ID of the content session to end"
}
},
"required": [
"PCID",
"content_session_id"
]
}
userflow_get_account
Get an account Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
account_id | string | Yes | — | Unique identifier for the account |
expand | string | No | — | Expand related objects (e.g. environments) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "string",
"description": "Unique identifier for the account"
},
"expand": {
"type": "string",
"description": "Expand related objects (e.g. environments)"
}
},
"required": [
"PCID",
"account_id"
]
}
userflow_get_content
Get a content object Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
content_id | string | Yes | — | Unique identifier for the content object |
expand | string | No | — | Expand related objects (e.g. draft_version, published_version) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"content_id": {
"type": "string",
"description": "Unique identifier for the content object"
},
"expand": {
"type": "string",
"description": "Expand related objects (e.g. draft_version, published_version)"
}
},
"required": [
"PCID",
"content_id"
]
}
userflow_get_content_session
Get a content session Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
session_id | string | Yes | — | Unique identifier for the content session |
expand | string | No | — | Expand related objects (e.g. answers, content, user, group, version) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"session_id": {
"type": "string",
"description": "Unique identifier for the content session"
},
"expand": {
"type": "string",
"description": "Expand related objects (e.g. answers, content, user, group, version)"
}
},
"required": [
"PCID",
"session_id"
]
}
userflow_get_content_version
Get a content version Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
version_id | string | Yes | — | Unique identifier for the content version |
expand | string | No | — | Expand related objects (e.g. questions, tasks) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"version_id": {
"type": "string",
"description": "Unique identifier for the content version"
},
"expand": {
"type": "string",
"description": "Expand related objects (e.g. questions, tasks)"
}
},
"required": [
"PCID",
"version_id"
]
}
userflow_get_group
Get a group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
group_id | string | Yes | — | Unique identifier for the group |
expand | string | No | — | Expand related objects (e.g. memberships, memberships.user, users) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"group_id": {
"type": "string",
"description": "Unique identifier for the group"
},
"expand": {
"type": "string",
"description": "Expand related objects (e.g. memberships, memberships.user, users)"
}
},
"required": [
"PCID",
"group_id"
]
}
userflow_get_invite
Get an invite Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
account_id | string | Yes | — | Unique identifier for the account |
invite_id | string | Yes | — | Unique identifier for the invite |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "string",
"description": "Unique identifier for the account"
},
"invite_id": {
"type": "string",
"description": "Unique identifier for the invite"
}
},
"required": [
"PCID",
"account_id",
"invite_id"
]
}
userflow_get_member
Get a member Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
account_id | string | Yes | — | Unique identifier for the account |
member_id | string | Yes | — | Unique identifier for the member |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "string",
"description": "Unique identifier for the account"
},
"member_id": {
"type": "string",
"description": "Unique identifier for the member"
}
},
"required": [
"PCID",
"account_id",
"member_id"
]
}
userflow_get_user
Get a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
user_id | string | Yes | — | Unique identifier for the user |
expand | string | No | — | Expand related objects (e.g. groups, memberships, memberships.group) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"user_id": {
"type": "string",
"description": "Unique identifier for the user"
},
"expand": {
"type": "string",
"description": "Expand related objects (e.g. groups, memberships, memberships.group)"
}
},
"required": [
"PCID",
"user_id"
]
}
userflow_get_webhook_subscription
Get a webhook subscription Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
webhook_subscription_id | string | Yes | — | ID of the webhook subscription |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"webhook_subscription_id": {
"type": "string",
"description": "ID of the webhook subscription"
}
},
"required": [
"PCID",
"webhook_subscription_id"
]
}
userflow_list_accounts
List accounts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Number of items to return (1-100, default 10) |
order_by | string | No | — | Fields to order by. Supported: name, created_at. |
starting_after | string | No | — | Cursor for pagination |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "Number of items to return (1-100, default 10)"
},
"order_by": {
"type": "string",
"description": "Fields to order by. Supported: name, created_at."
},
"starting_after": {
"type": "string",
"description": "Cursor for pagination"
}
},
"required": [
"PCID"
]
}
userflow_list_attribute_definitions
List attribute definitions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
scope | string | No | — | Filter by scope: event, group, group_membership, user |
event_name | string | No | — | Only include definitions used in given event(s) |
limit | integer | No | — | Number of items to return (1-100, default 10) |
order_by | string | No | — | Fields to order by. Supported: created_at, display_name, name. |
starting_after | string | No | — | Cursor for pagination |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"scope": {
"type": "string",
"description": "Filter by scope: event, group, group_membership, user",
"enum": [
"event",
"group",
"group_membership",
"user"
]
},
"event_name": {
"type": "string",
"description": "Only include definitions used in given event(s)"
},
"limit": {
"type": "integer",
"description": "Number of items to return (1-100, default 10)"
},
"order_by": {
"type": "string",
"description": "Fields to order by. Supported: created_at, display_name, name."
},
"starting_after": {
"type": "string",
"description": "Cursor for pagination"
}
},
"required": [
"PCID"
]
}
userflow_list_content
List content Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
type | string | No | — | Filter by content type: checklist, flow, or launcher |
limit | integer | No | — | Number of items to return (1-100, default 10) |
order_by | string | No | — | Fields to order by. Supported: created_at, name. Prefix with - for descending. |
starting_after | string | No | — | Cursor for pagination |
expand | string | No | — | Expand related objects (e.g. draft_version, published_version) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"type": {
"type": "string",
"description": "Filter by content type: checklist, flow, or launcher",
"enum": [
"checklist",
"flow",
"launcher"
]
},
"limit": {
"type": "integer",
"description": "Number of items to return (1-100, default 10)"
},
"order_by": {
"type": "string",
"description": "Fields to order by. Supported: created_at, name. Prefix with - for descending."
},
"starting_after": {
"type": "string",
"description": "Cursor for pagination"
},
"expand": {
"type": "string",
"description": "Expand related objects (e.g. draft_version, published_version)"
}
},
"required": [
"PCID"
]
}
userflow_list_content_sessions
List content sessions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
content_id | string | No | — | Only include sessions for this content object |
user_id | string | No | — | Only include sessions for this user |
limit | integer | No | — | Number of items to return (1-100, default 10) |
order_by | string | No | — | Fields to order by. Supported: created_at, last_activity_at. Prefix with - for descending. |
starting_after | string | No | — | Cursor for pagination |
expand | string | No | — | Expand related objects (e.g. answers, content, user, group, version) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"content_id": {
"type": "string",
"description": "Only include sessions for this content object"
},
"user_id": {
"type": "string",
"description": "Only include sessions for this user"
},
"limit": {
"type": "integer",
"description": "Number of items to return (1-100, default 10)"
},
"order_by": {
"type": "string",
"description": "Fields to order by. Supported: created_at, last_activity_at. Prefix with - for descending."
},
"starting_after": {
"type": "string",
"description": "Cursor for pagination"
},
"expand": {
"type": "string",
"description": "Expand related objects (e.g. answers, content, user, group, version)"
}
},
"required": [
"PCID"
]
}
userflow_list_content_versions
List content versions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
content_id | string | Yes | — | List versions of this content object (required) |
number | integer | No | — | Filter by version number |
limit | integer | No | — | Number of items to return (1-100, default 10) |
order_by | string | No | — | Fields to order by. Supported: number. |
starting_after | string | No | — | Cursor for pagination |
expand | string | No | — | Expand related objects (e.g. questions, tasks) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"content_id": {
"type": "string",
"description": "List versions of this content object (required)"
},
"number": {
"type": "integer",
"description": "Filter by version number"
},
"limit": {
"type": "integer",
"description": "Number of items to return (1-100, default 10)"
},
"order_by": {
"type": "string",
"description": "Fields to order by. Supported: number."
},
"starting_after": {
"type": "string",
"description": "Cursor for pagination"
},
"expand": {
"type": "string",
"description": "Expand related objects (e.g. questions, tasks)"
}
},
"required": [
"PCID",
"content_id"
]
}
userflow_list_event_definitions
List event definitions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Number of items to return (1-100, default 10) |
order_by | string | No | — | Fields to order by. Supported: created_at, display_name, name. |
starting_after | string | No | — | Cursor for pagination |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "Number of items to return (1-100, default 10)"
},
"order_by": {
"type": "string",
"description": "Fields to order by. Supported: created_at, display_name, name."
},
"starting_after": {
"type": "string",
"description": "Cursor for pagination"
}
},
"required": [
"PCID"
]
}
userflow_list_groups
List groups Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
condition | string | No | — | JSON condition to filter by attributes |
limit | integer | No | — | Number of items to return (1-100, default 10) |
order_by | string | No | — | Fields to order by. Supported: created_at, attributes.name. Prefix with - for descending. |
segment_id | string | No | — | Only include groups in this segment |
starting_after | string | No | — | Cursor for pagination |
user_id | string | No | — | Only include groups that this user is a member of |
expand | string | No | — | Expand related objects (e.g. memberships, memberships.user, users) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"condition": {
"type": "string",
"description": "JSON condition to filter by attributes"
},
"limit": {
"type": "integer",
"description": "Number of items to return (1-100, default 10)"
},
"order_by": {
"type": "string",
"description": "Fields to order by. Supported: created_at, attributes.name. Prefix with - for descending."
},
"segment_id": {
"type": "string",
"description": "Only include groups in this segment"
},
"starting_after": {
"type": "string",
"description": "Cursor for pagination"
},
"user_id": {
"type": "string",
"description": "Only include groups that this user is a member of"
},
"expand": {
"type": "string",
"description": "Expand related objects (e.g. memberships, memberships.user, users)"
}
},
"required": [
"PCID"
]
}
userflow_list_invites
List invites Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
account_id | string | Yes | — | Unique identifier for the account |
email | string | No | — | Filter by invitee email |
is_expired | boolean | No | — | Filter by expired status |
limit | integer | No | — | Number of items to return (1-100, default 10) |
order_by | string | No | — | Fields to order by. Supported: name, created_at. |
starting_after | string | No | — | Cursor for pagination |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "string",
"description": "Unique identifier for the account"
},
"email": {
"type": "string",
"description": "Filter by invitee email"
},
"is_expired": {
"type": "boolean",
"description": "Filter by expired status"
},
"limit": {
"type": "integer",
"description": "Number of items to return (1-100, default 10)"
},
"order_by": {
"type": "string",
"description": "Fields to order by. Supported: name, created_at."
},
"starting_after": {
"type": "string",
"description": "Cursor for pagination"
}
},
"required": [
"PCID",
"account_id"
]
}
userflow_list_members
List members Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
account_id | string | Yes | — | Unique identifier for the account |
email | string | No | — | Filter by email |
role | string | No | — | Filter by role (owner, admin, editor, viewer) |
limit | integer | No | — | Number of items to return (1-100, default 10) |
order_by | string | No | — | Fields to order by. Supported: created_at. |
starting_after | string | No | — | Cursor for pagination |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "string",
"description": "Unique identifier for the account"
},
"email": {
"type": "string",
"description": "Filter by email"
},
"role": {
"type": "string",
"description": "Filter by role (owner, admin, editor, viewer)"
},
"limit": {
"type": "integer",
"description": "Number of items to return (1-100, default 10)"
},
"order_by": {
"type": "string",
"description": "Fields to order by. Supported: created_at."
},
"starting_after": {
"type": "string",
"description": "Cursor for pagination"
}
},
"required": [
"PCID",
"account_id"
]
}
userflow_list_users
List users Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
condition | string | No | — | JSON condition to filter by attributes. See Userflow Condition Filtering docs. |
email | string | No | — | Only include users whose email attribute equals this value |
group_id | string | No | — | Only include users who are members of this group |
limit | integer | No | — | Number of items to return (1-100, default 10) |
order_by | string | No | — | Fields to order by. Supported: created_at, attributes.signed_up_at, attributes.last_seen_at, attributes.name. Prefix with - for descending. |
segment_id | string | No | — | Only include users in this segment |
starting_after | string | No | — | Cursor for pagination. Return items after the object with this ID. |
expand | string | No | — | Expand related objects (e.g. groups, memberships, memberships.group) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"condition": {
"type": "string",
"description": "JSON condition to filter by attributes. See Userflow Condition Filtering docs."
},
"email": {
"type": "string",
"description": "Only include users whose email attribute equals this value"
},
"group_id": {
"type": "string",
"description": "Only include users who are members of this group"
},
"limit": {
"type": "integer",
"description": "Number of items to return (1-100, default 10)"
},
"order_by": {
"type": "string",
"description": "Fields to order by. Supported: created_at, attributes.signed_up_at, attributes.last_seen_at, attributes.name. Prefix with - for descending."
},
"segment_id": {
"type": "string",
"description": "Only include users in this segment"
},
"starting_after": {
"type": "string",
"description": "Cursor for pagination. Return items after the object with this ID."
},
"expand": {
"type": "string",
"description": "Expand related objects (e.g. groups, memberships, memberships.group)"
}
},
"required": [
"PCID"
]
}
userflow_list_webhook_subscriptions
List webhook subscriptions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Number of items to return (1-100, default 10) |
order_by | string | No | — | Fields to order by. Supported: created_at, url. |
starting_after | string | No | — | Cursor for pagination |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "Number of items to return (1-100, default 10)"
},
"order_by": {
"type": "string",
"description": "Fields to order by. Supported: created_at, url."
},
"starting_after": {
"type": "string",
"description": "Cursor for pagination"
}
},
"required": [
"PCID"
]
}
userflow_remove_group_membership
Remove a user from a group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
user_id | string | Yes | — | Unique identifier for the user |
group_id | string | Yes | — | Unique identifier for the group |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"user_id": {
"type": "string",
"description": "Unique identifier for the user"
},
"group_id": {
"type": "string",
"description": "Unique identifier for the group"
}
},
"required": [
"PCID",
"user_id",
"group_id"
]
}
userflow_remove_member
Remove a member Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
account_id | string | Yes | — | Unique identifier for the account |
member_id | string | Yes | — | Unique identifier for the member |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "string",
"description": "Unique identifier for the account"
},
"member_id": {
"type": "string",
"description": "Unique identifier for the member"
}
},
"required": [
"PCID",
"account_id",
"member_id"
]
}
userflow_track_event
Track an event Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
attributes | object | No | — | Map of event attributes |
group_id | string | No | — | ID of the associated group. At least one of user_id or group_id is required. |
name | string | Yes | — | Name of the action performed. Must conform to event naming rules (a-z, A-Z, 0-9, underscores, dashes, periods, spaces). |
time | string | No | — | ISO 8601 datetime of when event happened. Defaults to current time. |
user_id | string | No | — | ID of the associated user. At least one of user_id or group_id is required. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"attributes": {
"type": "object",
"description": "Map of event attributes"
},
"group_id": {
"type": "string",
"description": "ID of the associated group. At least one of user_id or group_id is required."
},
"name": {
"type": "string",
"description": "Name of the action performed. Must conform to event naming rules (a-z, A-Z, 0-9, underscores, dashes, periods, spaces)."
},
"time": {
"type": "string",
"description": "ISO 8601 datetime of when event happened. Defaults to current time."
},
"user_id": {
"type": "string",
"description": "ID of the associated user. At least one of user_id or group_id is required."
}
},
"required": [
"PCID",
"name"
]
}
userflow_update_member
Update a member Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
account_id | string | Yes | — | Unique identifier for the account |
member_id | string | Yes | — | Unique identifier for the member |
permissions | object[] | No | — | Replaces existing permissions |
role | string | No | — | New role for the member |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"account_id": {
"type": "string",
"description": "Unique identifier for the account"
},
"member_id": {
"type": "string",
"description": "Unique identifier for the member"
},
"permissions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"action": {
"type": "string",
"description": "Action: manage_team or publish_flow"
},
"subject": {
"type": "string",
"description": "Subject type: account or environment"
},
"subject_id": {
"type": "string",
"description": "ID of the subject. Use * for all environments."
}
}
},
"description": "Replaces existing permissions"
},
"role": {
"type": "string",
"description": "New role for the member",
"enum": [
"admin",
"editor",
"viewer"
]
}
},
"required": [
"PCID",
"account_id",
"member_id"
]
}
userflow_update_webhook_subscription
Update a webhook subscription Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
webhook_subscription_id | string | Yes | — | ID of the webhook subscription |
api_version | string | No | — | API version for notifications |
disabled | boolean | No | — | Set true to pause notifications |
topics | string[] | No | — | Webhook topics to subscribe to |
url | string | No | — | URL for POST notifications |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"webhook_subscription_id": {
"type": "string",
"description": "ID of the webhook subscription"
},
"api_version": {
"type": "string",
"description": "API version for notifications"
},
"disabled": {
"type": "boolean",
"description": "Set true to pause notifications"
},
"topics": {
"type": "array",
"items": {
"type": "string"
},
"description": "Webhook topics to subscribe to"
},
"url": {
"type": "string",
"description": "URL for POST notifications"
}
},
"required": [
"PCID",
"webhook_subscription_id"
]
}

