Documentation Index
Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
Use this file to discover all available pages before exploring further.
Server path: /gleap-users-teams | Type: Application | PCID required: Yes
gleap_users_teams_authenticate_user_pusher_channel_session
Authenticate user for Pusher session.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
channel_name | string | Yes | — | Channel Name |
socket_id | string | Yes | — | Socket Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"channel_name": {
"type": "string",
"description": "Channel Name"
},
"socket_id": {
"type": "string",
"description": "Socket Id"
}
},
"required": [
"PCID",
"channel_name",
"socket_id"
]
}
gleap_users_teams_authenticate_user_pusher_session
Authenticate user for Pusher session.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
socket_id | string | Yes | — | Socket Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"socket_id": {
"type": "string",
"description": "Socket Id"
}
},
"required": [
"PCID",
"socket_id"
]
}
gleap_users_teams_create
Create a new user.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
email | string | No | — | The email value |
name | string | No | — | The name value |
onboardingFlow | string | No | — | Onboarding Flow |
password | string | No | — | The password value |
referral | string | No | — | The referral value |
turnstileToken | string | No | — | Turnstile Token |
utm_campaign | string | No | — | Utm Campaign |
utm_content | string | No | — | Utm Content |
utm_medium | string | No | — | Utm Medium |
utm_source | string | No | — | Utm Source |
utm_term | string | No | — | Utm Term |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"email": {
"type": "string",
"description": "The email value"
},
"name": {
"type": "string",
"description": "The name value"
},
"onboardingFlow": {
"type": "string",
"description": "Onboarding Flow"
},
"password": {
"type": "string",
"description": "The password value"
},
"referral": {
"type": "string",
"description": "The referral value"
},
"turnstileToken": {
"type": "string",
"description": "Turnstile Token"
},
"utm_campaign": {
"type": "string",
"description": "Utm Campaign"
},
"utm_content": {
"type": "string",
"description": "Utm Content"
},
"utm_medium": {
"type": "string",
"description": "Utm Medium"
},
"utm_source": {
"type": "string",
"description": "Utm Source"
},
"utm_term": {
"type": "string",
"description": "Utm Term"
}
},
"required": [
"PCID"
]
}
gleap_users_teams_create_organisation_invitation
Create a new invitation for an organisation
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
organisationId | string | Yes | — | Organisation Id |
emails | string[] | Yes | — | The emails value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organisationId": {
"type": "string",
"description": "Organisation Id"
},
"emails": {
"type": "array",
"items": {
"type": "string"
},
"description": "The emails value"
}
},
"required": [
"PCID",
"organisationId",
"emails"
]
}
gleap_users_teams_create_project_invitation
Create a new invitation for a project
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
emails | string[] | Yes | — | The emails value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"emails": {
"type": "array",
"items": {
"type": "string"
},
"description": "The emails value"
}
},
"required": [
"PCID",
"emails"
]
}
gleap_users_teams_create_team
Create a new team
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
assignmentMethod | string | Yes | — | Assignment Method |
limitTicketAmount | boolean | No | — | Limit Ticket Amount |
members | string[] | Yes | — | The members value |
name | string | Yes | — | The name value |
needQueueRerun | boolean | No | — | Need Queue Rerun |
selectOnlyOnlineMembers | boolean | No | — | Select Only Online Members |
ticketAmount | number | No | — | Ticket Amount |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"assignmentMethod": {
"type": "string",
"description": "Assignment Method",
"enum": [
"random",
"balanced",
"manual",
"circular"
]
},
"limitTicketAmount": {
"type": "boolean",
"description": "Limit Ticket Amount"
},
"members": {
"type": "array",
"items": {
"type": "string"
},
"description": "The members value"
},
"name": {
"type": "string",
"description": "The name value"
},
"needQueueRerun": {
"type": "boolean",
"description": "Need Queue Rerun"
},
"selectOnlyOnlineMembers": {
"type": "boolean",
"description": "Select Only Online Members"
},
"ticketAmount": {
"type": "number",
"description": "Ticket Amount"
}
},
"required": [
"PCID",
"assignmentMethod",
"members",
"name"
]
}
gleap_users_teams_delete_invitation
Delete an invitation
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
invitationId | string | Yes | — | Invitation Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"invitationId": {
"type": "string",
"description": "Invitation Id"
}
},
"required": [
"PCID",
"invitationId"
]
}
gleap_users_teams_delete_team
Delete a team
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
teamId | string | Yes | — | Team Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"teamId": {
"type": "string",
"description": "Team Id"
}
},
"required": [
"PCID",
"teamId"
]
}
gleap_users_teams_delete_user
Delete a user for a project
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
userId | string | Yes | — | User Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User Id"
}
},
"required": [
"PCID",
"userId"
]
}
gleap_users_teams_get_me
Get current user.
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
gleap_users_teams_get_my_invitations
Get all invitations for a user
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
gleap_users_teams_get_my_permissions
Get current user’s role permissions.
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
gleap_users_teams_get_organisation_invitations
Get all invitations for an organisation
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
organisationId | string | Yes | — | Organisation Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organisationId": {
"type": "string",
"description": "Organisation Id"
}
},
"required": [
"PCID",
"organisationId"
]
}
gleap_users_teams_get_project_invitations
Get all invitations for a project
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
gleap_users_teams_get_teams
Get all teams
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
gleap_users_teams_get_unified_inbox_ticket
Get unified inbox ticket
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
ticketId | string | Yes | — | Ticket Id |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ticketId": {
"type": "string",
"description": "Ticket Id"
}
},
"required": [
"PCID",
"ticketId"
]
}
gleap_users_teams_get_unified_inbox_tickets
Get unified inbox tickets
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
type | string | No | — | The type value |
filteredProjectId | string | No | — | Filtered Project Id |
page | number | No | — | Page number for pagination |
limit | number | No | — | Maximum number of results to return |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"type": {
"type": "string",
"description": "The type value"
},
"filteredProjectId": {
"type": "string",
"description": "Filtered Project Id"
},
"page": {
"type": "number",
"description": "Page number for pagination"
},
"limit": {
"type": "number",
"description": "Maximum number of results to return"
}
},
"required": [
"PCID"
]
}
gleap_users_teams_get_users
Get all users for a project
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
gleap_users_teams_reassign_tickets
Reassign all tickets to the user.
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
gleap_users_teams_resend
Resend a verification code to the user’s email.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | string | Yes | — | The id value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
}
},
"required": [
"PCID",
"id"
]
}
gleap_users_teams_update
Update user.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
userId | string | Yes | — | The userId identifier |
available | boolean | No | — | The available value |
completedOnboarding | boolean | No | — | Completed Onboarding |
firstName | string | No | — | First Name |
knewGleapFrom | string | No | — | Knew Gleap From |
lastName | string | No | — | Last Name |
notificationPreferences | object | No | — | Notification Preferences |
notificationSettings | object | No | — | Notification Settings |
oldpassword | string | No | — | The oldpassword value |
profileImageUrl | string | No | — | Profile Image Url |
unavailableProjects | string[] | No | — | Unavailable Projects |
userRole | string | No | — | User Role |
userUsage | string | No | — | User Usage |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "The userId identifier"
},
"available": {
"type": "boolean",
"description": "The available value"
},
"completedOnboarding": {
"type": "boolean",
"description": "Completed Onboarding"
},
"firstName": {
"type": "string",
"description": "First Name"
},
"knewGleapFrom": {
"type": "string",
"description": "Knew Gleap From"
},
"lastName": {
"type": "string",
"description": "Last Name"
},
"notificationPreferences": {
"description": "Notification Preferences"
},
"notificationSettings": {
"description": "Notification Settings"
},
"oldpassword": {
"type": "string",
"description": "The oldpassword value"
},
"profileImageUrl": {
"type": "string",
"description": "Profile Image Url"
},
"unavailableProjects": {
"type": "array",
"items": {
"type": "string"
},
"description": "Unavailable Projects"
},
"userRole": {
"type": "string",
"description": "User Role"
},
"userUsage": {
"type": "string",
"description": "User Usage"
}
},
"required": [
"PCID",
"userId"
]
}
gleap_users_teams_update_invitation
Update an invitation
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
invitationId | string | Yes | — | Invitation Id |
accept | boolean | Yes | — | The accept value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"invitationId": {
"type": "string",
"description": "Invitation Id"
},
"accept": {
"type": "boolean",
"description": "The accept value"
}
},
"required": [
"PCID",
"invitationId",
"accept"
]
}
gleap_users_teams_update_invitation_role
Update an invitation for a project
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
invitationId | string | Yes | — | Invitation Id |
role | string | Yes | — | The role value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"invitationId": {
"type": "string",
"description": "Invitation Id"
},
"role": {
"type": "string",
"description": "The role value"
}
},
"required": [
"PCID",
"invitationId",
"role"
]
}
gleap_users_teams_update_team
Update a team
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
teamId | string | Yes | — | Team Id |
assignmentMethod | string | Yes | — | Assignment Method |
limitTicketAmount | boolean | No | — | Limit Ticket Amount |
members | string[] | Yes | — | The members value |
name | string | Yes | — | The name value |
needQueueRerun | boolean | No | — | Need Queue Rerun |
selectOnlyOnlineMembers | boolean | No | — | Select Only Online Members |
ticketAmount | number | No | — | Ticket Amount |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"teamId": {
"type": "string",
"description": "Team Id"
},
"assignmentMethod": {
"type": "string",
"description": "Assignment Method",
"enum": [
"random",
"balanced",
"manual",
"circular"
]
},
"limitTicketAmount": {
"type": "boolean",
"description": "Limit Ticket Amount"
},
"members": {
"type": "array",
"items": {
"type": "string"
},
"description": "The members value"
},
"name": {
"type": "string",
"description": "The name value"
},
"needQueueRerun": {
"type": "boolean",
"description": "Need Queue Rerun"
},
"selectOnlyOnlineMembers": {
"type": "boolean",
"description": "Select Only Online Members"
},
"ticketAmount": {
"type": "number",
"description": "Ticket Amount"
}
},
"required": [
"PCID",
"teamId",
"assignmentMethod",
"members",
"name"
]
}
gleap_users_teams_update_user
Update a user for a project
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
userId | string | Yes | — | User Id |
role | string | Yes | — | The role value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"userId": {
"type": "string",
"description": "User Id"
},
"role": {
"type": "string",
"description": "The role value"
}
},
"required": [
"PCID",
"userId",
"role"
]
}
gleap_users_teams_verify
Verify user email address.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
code | string | Yes | — | The code value |
email | string | Yes | — | The email value |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"code": {
"type": "string",
"description": "The code value"
},
"email": {
"type": "string",
"description": "The email value"
}
},
"required": [
"PCID",
"code",
"email"
]
}
