zendesk-users-orgs - Pinkfish - AI Agents & Workflows for Getting Work Done

Server path: /zendesk-users-orgs | Type: Application | PCID required: Yes

Tools

Tool	Description
`zendesk_users_orgs_autocomplete_organizations`	Autocomplete Organizations
`zendesk_users_orgs_autocomplete_users`	Autocomplete Users
`zendesk_users_orgs_count_groups`	Count Groups
`zendesk_users_orgs_count_organizations`	Count Organizations
`zendesk_users_orgs_count_users`	Count Users
`zendesk_users_orgs_create_group`	Create Group
`zendesk_users_orgs_create_or_update_user`	Create Or Update User
`zendesk_users_orgs_create_organization`	Create Organization
`zendesk_users_orgs_create_user`	Create User
`zendesk_users_orgs_delete_group`	Delete Group
`zendesk_users_orgs_delete_organization`	Delete Organization
`zendesk_users_orgs_delete_user`	Delete User
`zendesk_users_orgs_get_group`	Show Group
`zendesk_users_orgs_get_organization`	Show Organization
`zendesk_users_orgs_get_user`	Show User
`zendesk_users_orgs_list_groups`	List Groups
`zendesk_users_orgs_list_organization_users`	List Organization Users
`zendesk_users_orgs_list_organizations`	List Organizations
`zendesk_users_orgs_list_user_groups`	List User Groups
`zendesk_users_orgs_list_user_organizations`	List User Organizations
`zendesk_users_orgs_list_users`	List Users
`zendesk_users_orgs_organization_related`	Show Organization’s Related Information
`zendesk_users_orgs_search_organizations`	Search Organizations
`zendesk_users_orgs_search_users`	Search Users
`zendesk_users_orgs_show_current_user`	Show Self
`zendesk_users_orgs_show_many_organizations`	Show Many Organizations
`zendesk_users_orgs_show_many_users`	Show Many Users
`zendesk_users_orgs_show_user_related`	Show User Related Information
`zendesk_users_orgs_update_group`	Update Group
`zendesk_users_orgs_update_organization`	Update Organization
`zendesk_users_orgs_update_user`	Update User

zendesk_users_orgs_autocomplete_organizations

Autocomplete Organizations Parameters:

Parameter	Type	Required	Default	Description
`name`	string	Yes	—	A substring of an organization to search for
`field_id`	string	No	—	The id of a lookup relationship field. The type of field is determined by the `source` param
`source`	string	No	—	If a `field_id` is provided, this specifies the type of the field. For example, if the field is on a “zen:user”, it references a field on a user
`include_boundary_indicators`	boolean	No	—	When true, includes `has_more` indicator in the cursor pagination response meta. Only valid with cursor pagination (page[size], page[after], page[before]).
`include_item_cursors`	boolean	No	—	When true, includes cursor values for each item in the cursor pagination response. Only valid with cursor pagination (page[size], page[after], page[before]).

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "name": {
      "type": "string",
      "description": "A substring of an organization to search for"
    },
    "field_id": {
      "type": "string",
      "description": "The id of a lookup relationship field.  The type of field is determined by the `source` param"
    },
    "source": {
      "type": "string",
      "description": "If a `field_id` is provided, this specifies the type of the field. For example, if the field is on a \"zen:user\", it references a field on a user"
    },
    "include_boundary_indicators": {
      "type": "boolean",
      "description": "When true, includes `has_more` indicator in the cursor pagination response meta.  Only valid with cursor pagination (page[size], page[after], page[before])."
    },
    "include_item_cursors": {
      "type": "boolean",
      "description": "When true, includes cursor values for each item in the cursor pagination response.  Only valid with cursor pagination (page[size], page[after], page[before])."
    }
  },
  "required": [
    "PCID",
    "name"
  ]
}

zendesk_users_orgs_autocomplete_users

Autocomplete Users Parameters:

Parameter	Type	Required	Default	Description
`name`	string	No	—	The name to search for the user. You must specify either `name` or `phone`.
`phone`	string	No	—	The phone number to search for the user. You must specify either `name` or `phone`.
`filter`	string	No	—	Filter to apply to autocomplete results. Accepted values: `assignable`, `requester`.
`field_id`	string	No	—	The id of a lookup relationship field. The type of field is determined by the `source` param
`source`	string	No	—	If a `field_id` is provided, this specifies the type of the field. For example, if the field is on a “zen:user”, it references a field on a user
`include`	string	No	—	Sideloads to include in the response. Accepts a comma-separated list of values. See Sideloading.
`per_page`	integer	No	—	Number of results to return.
`brand_id`	integer	No	—	When brand separation is enabled, scopes the autocomplete results to users belonging to the specified brand. Only applicable when the account has brand separation enabled.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "name": {
      "type": "string",
      "description": "The name to search for the user. You must specify either `name` or `phone`."
    },
    "phone": {
      "type": "string",
      "description": "The phone number to search for the user. You must specify either `name` or `phone`."
    },
    "filter": {
      "type": "string",
      "description": "Filter to apply to autocomplete results. Accepted values: `assignable`, `requester`.",
      "enum": [
        "assignable",
        "requester"
      ]
    },
    "field_id": {
      "type": "string",
      "description": "The id of a lookup relationship field.  The type of field is determined by the `source` param"
    },
    "source": {
      "type": "string",
      "description": "If a `field_id` is provided, this specifies the type of the field. For example, if the field is on a \"zen:user\", it references a field on a user"
    },
    "include": {
      "type": "string",
      "description": "Sideloads to include in the response. Accepts a comma-separated list of values. See [Sideloading](/api-reference/ticketing/users/users/#sideloading)."
    },
    "per_page": {
      "type": "integer",
      "description": "Number of results to return."
    },
    "brand_id": {
      "type": "integer",
      "description": "When brand separation is enabled, scopes the autocomplete results to users belonging to the specified brand. Only applicable when the account has brand separation enabled."
    }
  },
  "required": [
    "PCID"
  ]
}

zendesk_users_orgs_count_groups

Count Groups

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

zendesk_users_orgs_count_organizations

Count Organizations Parameters:

Parameter	Type	Required	Default	Description
`include_boundary_indicators`	boolean	No	—	When true, includes `has_more` indicator in the cursor pagination response meta. Only valid with cursor pagination (page[size], page[after], page[before]).
`include_item_cursors`	boolean	No	—	When true, includes cursor values for each item in the cursor pagination response. Only valid with cursor pagination (page[size], page[after], page[before]).

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "include_boundary_indicators": {
      "type": "boolean",
      "description": "When true, includes `has_more` indicator in the cursor pagination response meta.  Only valid with cursor pagination (page[size], page[after], page[before])."
    },
    "include_item_cursors": {
      "type": "boolean",
      "description": "When true, includes cursor values for each item in the cursor pagination response.  Only valid with cursor pagination (page[size], page[after], page[before])."
    }
  },
  "required": [
    "PCID"
  ]
}

zendesk_users_orgs_count_users

Count Users Parameters:

Parameter	Type	Required	Default	Description
`role`	string	No	—	Filters the results by role. Possible values are “end-user”, “agent”, “admin”, or a custom role name
`role[]`	string	No	—	Filters the results by more than one role using the format `role[]={role}&role[]={role}`
`permission_set`	integer	No	—	For custom roles which is available on the Enterprise plan and above. You can only filter by one role ID per request

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "role": {
      "type": "string",
      "description": "Filters the results by role. Possible values are \"end-user\", \"agent\", \"admin\", or a custom role name"
    },
    "role[]": {
      "type": "string",
      "description": "Filters the results by more than one role using the format `role[]={role}&role[]={role}`"
    },
    "permission_set": {
      "type": "integer",
      "description": "For custom roles which is available on the Enterprise plan and above. You can only filter by one role ID per request"
    }
  },
  "required": [
    "PCID"
  ]
}

zendesk_users_orgs_create_group

Create Group

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

zendesk_users_orgs_create_or_update_user

Create Or Update User Parameters:

Parameter	Type	Required	Default	Description
`user`	object	Yes	—	The user value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "user": {
      "description": "The user value"
    }
  },
  "required": [
    "PCID",
    "user"
  ]
}

zendesk_users_orgs_create_organization

Create Organization Parameters:

Parameter	Type	Required	Default	Description
`organization`	object	Yes	—	The organization value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "organization": {
      "type": "object",
      "description": "The organization value",
      "properties": {
        "created_at": {
          "type": "string",
          "description": "The time the organization was created"
        },
        "details": {
          "type": "string",
          "description": "Any details obout the organization, such as the address"
        },
        "domain_names": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "An array of domain names associated with this organization"
        },
        "external_id": {
          "type": "string",
          "description": "A unique external id to associate organizations to an external record. The id is case-insensitive. For example, \"company1\" and \"Company1\" are considered the same"
        },
        "group_id": {
          "type": "integer",
          "description": "New tickets from users in this organization are automatically put in this group"
        },
        "id": {
          "type": "integer",
          "description": "Automatically assigned when the organization is created"
        },
        "name": {
          "type": "string",
          "description": "A unique name for the organization"
        },
        "notes": {
          "type": "string",
          "description": "Any notes you have about the organization"
        },
        "organization_fields": {
          "type": "object",
          "description": "Custom fields for this organization. See [Custom organization fields](/api-reference/ticketing/organizations/organizations/#custom-organization-fields)"
        },
        "shared_comments": {
          "type": "boolean",
          "description": "End users in this organization are able to comment on each other's tickets"
        },
        "shared_tickets": {
          "type": "boolean",
          "description": "End users in this organization are able to see each other's tickets"
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The tags of the organization"
        },
        "updated_at": {
          "type": "string",
          "description": "The time of the last update of the organization"
        },
        "url": {
          "type": "string",
          "description": "The API url of this organization"
        }
      },
      "required": [
        "name"
      ]
    }
  },
  "required": [
    "PCID",
    "organization"
  ]
}

zendesk_users_orgs_create_user

Create User Parameters:

Parameter	Type	Required	Default	Description
`user`	object	Yes	—	The user value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "user": {
      "description": "The user value"
    }
  },
  "required": [
    "PCID",
    "user"
  ]
}

zendesk_users_orgs_delete_group

Delete Group Parameters:

Parameter	Type	Required	Default	Description
`group_id`	integer	Yes	—	The ID of the group

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "group_id": {
      "type": "integer",
      "description": "The ID of the group"
    }
  },
  "required": [
    "PCID",
    "group_id"
  ]
}

zendesk_users_orgs_delete_organization

Delete Organization Parameters:

Parameter	Type	Required	Default	Description
`organization_id`	integer	Yes	—	The ID of an organization

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "organization_id": {
      "type": "integer",
      "description": "The ID of an organization"
    }
  },
  "required": [
    "PCID",
    "organization_id"
  ]
}

zendesk_users_orgs_delete_user

Delete User Parameters:

Parameter	Type	Required	Default	Description
`user_id`	integer	Yes	—	The id of the user

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "user_id": {
      "type": "integer",
      "description": "The id of the user"
    }
  },
  "required": [
    "PCID",
    "user_id"
  ]
}

zendesk_users_orgs_get_group

Show Group Parameters:

Parameter	Type	Required	Default	Description
`group_id`	integer	Yes	—	The ID of the group
`include`	string	No	—	Sideloads to include in the response. Accepts a comma-separated list of values.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "group_id": {
      "type": "integer",
      "description": "The ID of the group"
    },
    "include": {
      "type": "string",
      "description": "Sideloads to include in the response. Accepts a comma-separated list of values."
    }
  },
  "required": [
    "PCID",
    "group_id"
  ]
}

zendesk_users_orgs_get_organization

Show Organization Parameters:

Parameter	Type	Required	Default	Description
`organization_id`	integer	Yes	—	The ID of an organization
`include`	string	No	—	Include additional related data. Supported values: `lookup_relationship_fields`.
`include_boundary_indicators`	boolean	No	—	When true, includes `has_more` indicator in the cursor pagination response meta. Only valid with cursor pagination (page[size], page[after], page[before]).
`include_item_cursors`	boolean	No	—	When true, includes cursor values for each item in the cursor pagination response. Only valid with cursor pagination (page[size], page[after], page[before]).

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "organization_id": {
      "type": "integer",
      "description": "The ID of an organization"
    },
    "include": {
      "type": "string",
      "description": "Include additional related data. Supported values: `lookup_relationship_fields`."
    },
    "include_boundary_indicators": {
      "type": "boolean",
      "description": "When true, includes `has_more` indicator in the cursor pagination response meta.  Only valid with cursor pagination (page[size], page[after], page[before])."
    },
    "include_item_cursors": {
      "type": "boolean",
      "description": "When true, includes cursor values for each item in the cursor pagination response.  Only valid with cursor pagination (page[size], page[after], page[before])."
    }
  },
  "required": [
    "PCID",
    "organization_id"
  ]
}

zendesk_users_orgs_get_user

Show User Parameters:

Parameter	Type	Required	Default	Description
`user_id`	integer	Yes	—	The id of the user
`include`	string	No	—	Sideloads to include in the response. Accepts a comma-separated list of values. See Sideloading.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "user_id": {
      "type": "integer",
      "description": "The id of the user"
    },
    "include": {
      "type": "string",
      "description": "Sideloads to include in the response. Accepts a comma-separated list of values. See [Sideloading](/api-reference/ticketing/users/users/#sideloading)."
    }
  },
  "required": [
    "PCID",
    "user_id"
  ]
}

zendesk_users_orgs_list_groups

List Groups Parameters:

Parameter	Type	Required	Default	Description
`exclude_deleted`	boolean	No	—	Whether to exclude deleted entities
`include`	string	No	—	Sideloads to include in the response. Accepts a comma-separated list of values.
`page`	object	No	—	Pagination parameter. Supports both traditional offset and cursor-based pagination: - Traditional: `?page=2` (integer page number) - Cursor: `?page[size]=50&page[after]=cursor` (deepObject with size, after, before) These are mutually exclusive - use one format or the other, not both.
`per_page`	integer	No	—	Number of records to return per page. Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits.
`sort`	string	No	—	Field to sort results by. Prefix with `-` for descending order. When used with cursor pagination, this determines the cursor ordering. Example: `?sort=name` or `?sort=-created_at`
`include_boundary_indicators`	boolean	No	—	When true, includes `has_more` indicator in the cursor pagination response meta. Only valid with cursor pagination (page[size], page[after], page[before]).
`include_item_cursors`	boolean	No	—	When true, includes cursor values for each item in the cursor pagination response. Only valid with cursor pagination (page[size], page[after], page[before]).

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "exclude_deleted": {
      "type": "boolean",
      "description": "Whether to exclude deleted entities"
    },
    "include": {
      "type": "string",
      "description": "Sideloads to include in the response. Accepts a comma-separated list of values."
    },
    "page": {
      "description": "Pagination parameter. Supports both traditional offset and cursor-based pagination:  - Traditional: `?page=2` (integer page number) - Cursor: `?page[size]=50&page[after]=cursor` (deepObject with size, after, before)  These are mutually exclusive - use one format or the other, not both."
    },
    "per_page": {
      "type": "integer",
      "description": "Number of records to return per page.  Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits."
    },
    "sort": {
      "type": "string",
      "description": "Field to sort results by. Prefix with `-` for descending order.  When used with cursor pagination, this determines the cursor ordering.  Example: `?sort=name` or `?sort=-created_at`"
    },
    "include_boundary_indicators": {
      "type": "boolean",
      "description": "When true, includes `has_more` indicator in the cursor pagination response meta.  Only valid with cursor pagination (page[size], page[after], page[before])."
    },
    "include_item_cursors": {
      "type": "boolean",
      "description": "When true, includes cursor values for each item in the cursor pagination response.  Only valid with cursor pagination (page[size], page[after], page[before])."
    }
  },
  "required": [
    "PCID"
  ]
}

zendesk_users_orgs_list_organization_users

List Organization Users Parameters:

Parameter	Type	Required	Default	Description
`organization_id`	integer	Yes	—	The ID of an organization
`role`	string	No	—	Filters the results by role. Possible values are “end-user”, “agent”, “admin”, or a custom role name
`role[]`	string	No	—	Filters the results by more than one role using the format `role[]={role}&role[]={role}`
`permission_set`	integer	No	—	For custom roles which is available on the Enterprise plan and above. You can only filter by one role ID per request
`external_id`	string	No	—	List users by external id. External id has to be unique for each user under the same account.
`sort_by`	string	No	—	The field to sort users by
`sort_order`	string	No	—	The sort order
`page`	object	No	—	Pagination parameter. Supports both traditional offset and cursor-based pagination: - Traditional: `?page=2` (integer page number) - Cursor: `?page[size]=50&page[after]=cursor` (deepObject with size, after, before) These are mutually exclusive - use one format or the other, not both.
`per_page`	integer	No	—	Number of records to return per page. Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "organization_id": {
      "type": "integer",
      "description": "The ID of an organization"
    },
    "role": {
      "type": "string",
      "description": "Filters the results by role. Possible values are \"end-user\", \"agent\", \"admin\", or a custom role name"
    },
    "role[]": {
      "type": "string",
      "description": "Filters the results by more than one role using the format `role[]={role}&role[]={role}`"
    },
    "permission_set": {
      "type": "integer",
      "description": "For custom roles which is available on the Enterprise plan and above. You can only filter by one role ID per request"
    },
    "external_id": {
      "type": "string",
      "description": "List users by external id. External id has to be unique for each user under the same account."
    },
    "sort_by": {
      "type": "string",
      "description": "The field to sort users by",
      "enum": [
        "id",
        "name",
        "created_at",
        "updated_at"
      ]
    },
    "sort_order": {
      "type": "string",
      "description": "The sort order",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "page": {
      "description": "Pagination parameter. Supports both traditional offset and cursor-based pagination:  - Traditional: `?page=2` (integer page number) - Cursor: `?page[size]=50&page[after]=cursor` (deepObject with size, after, before)  These are mutually exclusive - use one format or the other, not both."
    },
    "per_page": {
      "type": "integer",
      "description": "Number of records to return per page.  Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits."
    }
  },
  "required": [
    "PCID",
    "organization_id"
  ]
}

zendesk_users_orgs_list_organizations

List Organizations Parameters:

Parameter	Type	Required	Default	Description
`page`	object	No	—	Pagination parameter. Supports both traditional offset and cursor-based pagination: - Traditional: `?page=2` (integer page number) - Cursor: `?page[size]=50&page[after]=cursor` (deepObject with size, after, before) These are mutually exclusive - use one format or the other, not both.
`per_page`	integer	No	—	Number of records to return per page. Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits.
`sort`	string	No	—	Field to sort results by. Prefix with `-` for descending order. When used with cursor pagination, this determines the cursor ordering. Example: `?sort=name` or `?sort=-created_at`
`include_boundary_indicators`	boolean	No	—	When true, includes `has_more` indicator in the cursor pagination response meta. Only valid with cursor pagination (page[size], page[after], page[before]).
`include_item_cursors`	boolean	No	—	When true, includes cursor values for each item in the cursor pagination response. Only valid with cursor pagination (page[size], page[after], page[before]).

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "page": {
      "description": "Pagination parameter. Supports both traditional offset and cursor-based pagination:  - Traditional: `?page=2` (integer page number) - Cursor: `?page[size]=50&page[after]=cursor` (deepObject with size, after, before)  These are mutually exclusive - use one format or the other, not both."
    },
    "per_page": {
      "type": "integer",
      "description": "Number of records to return per page.  Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits."
    },
    "sort": {
      "type": "string",
      "description": "Field to sort results by. Prefix with `-` for descending order.  When used with cursor pagination, this determines the cursor ordering.  Example: `?sort=name` or `?sort=-created_at`"
    },
    "include_boundary_indicators": {
      "type": "boolean",
      "description": "When true, includes `has_more` indicator in the cursor pagination response meta.  Only valid with cursor pagination (page[size], page[after], page[before])."
    },
    "include_item_cursors": {
      "type": "boolean",
      "description": "When true, includes cursor values for each item in the cursor pagination response.  Only valid with cursor pagination (page[size], page[after], page[before])."
    }
  },
  "required": [
    "PCID"
  ]
}

zendesk_users_orgs_list_user_groups

List User Groups Parameters:

Parameter	Type	Required	Default	Description
`user_id`	integer	Yes	—	The id of the user
`exclude_deleted`	boolean	No	—	Whether to exclude deleted entities
`page`	object	No	—	Pagination parameter. Supports both traditional offset and cursor-based pagination: - Traditional: `?page=2` (integer page number) - Cursor: `?page[size]=50&page[after]=cursor` (deepObject with size, after, before) These are mutually exclusive - use one format or the other, not both.
`per_page`	integer	No	—	Number of records to return per page. Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits.
`sort`	string	No	—	Field to sort results by. Prefix with `-` for descending order. When used with cursor pagination, this determines the cursor ordering. Example: `?sort=name` or `?sort=-created_at`
`include_boundary_indicators`	boolean	No	—	When true, includes `has_more` indicator in the cursor pagination response meta. Only valid with cursor pagination (page[size], page[after], page[before]).
`include_item_cursors`	boolean	No	—	When true, includes cursor values for each item in the cursor pagination response. Only valid with cursor pagination (page[size], page[after], page[before]).

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "user_id": {
      "type": "integer",
      "description": "The id of the user"
    },
    "exclude_deleted": {
      "type": "boolean",
      "description": "Whether to exclude deleted entities"
    },
    "page": {
      "description": "Pagination parameter. Supports both traditional offset and cursor-based pagination:  - Traditional: `?page=2` (integer page number) - Cursor: `?page[size]=50&page[after]=cursor` (deepObject with size, after, before)  These are mutually exclusive - use one format or the other, not both."
    },
    "per_page": {
      "type": "integer",
      "description": "Number of records to return per page.  Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits."
    },
    "sort": {
      "type": "string",
      "description": "Field to sort results by. Prefix with `-` for descending order.  When used with cursor pagination, this determines the cursor ordering.  Example: `?sort=name` or `?sort=-created_at`"
    },
    "include_boundary_indicators": {
      "type": "boolean",
      "description": "When true, includes `has_more` indicator in the cursor pagination response meta.  Only valid with cursor pagination (page[size], page[after], page[before])."
    },
    "include_item_cursors": {
      "type": "boolean",
      "description": "When true, includes cursor values for each item in the cursor pagination response.  Only valid with cursor pagination (page[size], page[after], page[before])."
    }
  },
  "required": [
    "PCID",
    "user_id"
  ]
}

zendesk_users_orgs_list_user_organizations

List User Organizations Parameters:

Parameter	Type	Required	Default	Description
`user_id`	integer	Yes	—	The id of the user
`page`	object	No	—	Pagination parameter. Supports both traditional offset and cursor-based pagination: - Traditional: `?page=2` (integer page number) - Cursor: `?page[size]=50&page[after]=cursor` (deepObject with size, after, before) These are mutually exclusive - use one format or the other, not both.
`per_page`	integer	No	—	Number of records to return per page. Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits.
`sort`	string	No	—	Field to sort results by. Prefix with `-` for descending order. When used with cursor pagination, this determines the cursor ordering. Example: `?sort=name` or `?sort=-created_at`
`include_boundary_indicators`	boolean	No	—	When true, includes `has_more` indicator in the cursor pagination response meta. Only valid with cursor pagination (page[size], page[after], page[before]).
`include_item_cursors`	boolean	No	—	When true, includes cursor values for each item in the cursor pagination response. Only valid with cursor pagination (page[size], page[after], page[before]).

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "user_id": {
      "type": "integer",
      "description": "The id of the user"
    },
    "page": {
      "description": "Pagination parameter. Supports both traditional offset and cursor-based pagination:  - Traditional: `?page=2` (integer page number) - Cursor: `?page[size]=50&page[after]=cursor` (deepObject with size, after, before)  These are mutually exclusive - use one format or the other, not both."
    },
    "per_page": {
      "type": "integer",
      "description": "Number of records to return per page.  Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits."
    },
    "sort": {
      "type": "string",
      "description": "Field to sort results by. Prefix with `-` for descending order.  When used with cursor pagination, this determines the cursor ordering.  Example: `?sort=name` or `?sort=-created_at`"
    },
    "include_boundary_indicators": {
      "type": "boolean",
      "description": "When true, includes `has_more` indicator in the cursor pagination response meta.  Only valid with cursor pagination (page[size], page[after], page[before])."
    },
    "include_item_cursors": {
      "type": "boolean",
      "description": "When true, includes cursor values for each item in the cursor pagination response.  Only valid with cursor pagination (page[size], page[after], page[before])."
    }
  },
  "required": [
    "PCID",
    "user_id"
  ]
}

zendesk_users_orgs_list_users

List Users Parameters:

Parameter	Type	Required	Default	Description
`role`	string	No	—	Filters the results by role. Possible values are “end-user”, “agent”, “admin”, or a custom role name
`role[]`	string	No	—	Filters the results by more than one role using the format `role[]={role}&role[]={role}`
`permission_set`	integer	No	—	For custom roles which is available on the Enterprise plan and above. You can only filter by one role ID per request
`external_id`	string	No	—	List users by external id. External id has to be unique for each user under the same account.
`include`	string	No	—	Sideloads to include in the response. Accepts a comma-separated list of values. See Sideloading.
`page`	object	No	—	Pagination parameter. Supports both traditional offset and cursor-based pagination: - Traditional: `?page=2` (integer page number) - Cursor: `?page[size]=50&page[after]=cursor` (deepObject with size, after, before) These are mutually exclusive - use one format or the other, not both.
`per_page`	integer	No	—	Number of records to return per page. Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits.
`sort`	string	No	—	Field to sort results by. Prefix with `-` for descending order. When used with cursor pagination, this determines the cursor ordering. Example: `?sort=name` or `?sort=-created_at`
`include_boundary_indicators`	boolean	No	—	When true, includes `has_more` indicator in the cursor pagination response meta. Only valid with cursor pagination (page[size], page[after], page[before]).
`include_item_cursors`	boolean	No	—	When true, includes cursor values for each item in the cursor pagination response. Only valid with cursor pagination (page[size], page[after], page[before]).
`brand_id`	integer	No	—	When brand separation is enabled, scopes the listing to users belonging to the specified brand. Only applicable when the account has brand separation enabled.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "role": {
      "type": "string",
      "description": "Filters the results by role. Possible values are \"end-user\", \"agent\", \"admin\", or a custom role name"
    },
    "role[]": {
      "type": "string",
      "description": "Filters the results by more than one role using the format `role[]={role}&role[]={role}`"
    },
    "permission_set": {
      "type": "integer",
      "description": "For custom roles which is available on the Enterprise plan and above. You can only filter by one role ID per request"
    },
    "external_id": {
      "type": "string",
      "description": "List users by external id. External id has to be unique for each user under the same account."
    },
    "include": {
      "type": "string",
      "description": "Sideloads to include in the response. Accepts a comma-separated list of values. See [Sideloading](/api-reference/ticketing/users/users/#sideloading)."
    },
    "page": {
      "description": "Pagination parameter. Supports both traditional offset and cursor-based pagination:  - Traditional: `?page=2` (integer page number) - Cursor: `?page[size]=50&page[after]=cursor` (deepObject with size, after, before)  These are mutually exclusive - use one format or the other, not both."
    },
    "per_page": {
      "type": "integer",
      "description": "Number of records to return per page.  Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits."
    },
    "sort": {
      "type": "string",
      "description": "Field to sort results by. Prefix with `-` for descending order.  When used with cursor pagination, this determines the cursor ordering.  Example: `?sort=name` or `?sort=-created_at`"
    },
    "include_boundary_indicators": {
      "type": "boolean",
      "description": "When true, includes `has_more` indicator in the cursor pagination response meta.  Only valid with cursor pagination (page[size], page[after], page[before])."
    },
    "include_item_cursors": {
      "type": "boolean",
      "description": "When true, includes cursor values for each item in the cursor pagination response.  Only valid with cursor pagination (page[size], page[after], page[before])."
    },
    "brand_id": {
      "type": "integer",
      "description": "When brand separation is enabled, scopes the listing to users belonging to the specified brand. Only applicable when the account has brand separation enabled."
    }
  },
  "required": [
    "PCID"
  ]
}

zendesk_users_orgs_organization_related

Show Organization’s Related Information Parameters:

Parameter	Type	Required	Default	Description
`organization_id`	integer	Yes	—	The ID of an organization

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "organization_id": {
      "type": "integer",
      "description": "The ID of an organization"
    }
  },
  "required": [
    "PCID",
    "organization_id"
  ]
}

zendesk_users_orgs_search_organizations

Search Organizations Parameters:

Parameter	Type	Required	Default	Description
`external_id`	integer	No	—	The external id of an organization
`name`	string	No	—	The name of an organization

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "external_id": {
      "type": "integer",
      "description": "The external id of an organization"
    },
    "name": {
      "type": "string",
      "description": "The name of an organization"
    }
  },
  "required": [
    "PCID"
  ]
}

zendesk_users_orgs_search_users

Search Users Parameters:

Parameter	Type	Required	Default	Description
`page`	integer	No	—	Page number for offset-based pagination (non-negative integer).
`per_page`	integer	No	—	Number of records to return per page. Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits.
`query`	string	No	—	The `query` parameter supports the Zendesk search syntax for more advanced user searches. It can specify a partial or full value of any user property, including name, email address, notes, or phone. Example: `query="jdoe"`. See the Search API.
`external_id`	string	No	—	The `external_id` parameter does not support the search syntax. It only accepts ids.
`brand_id`	integer	No	—	When brand separation is enabled, scopes the search to users belonging to the specified brand. Only applicable when the account has brand separation enabled.
`include`	string	No	—	A comma-separated list of sideloads to include in the response.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "page": {
      "type": "integer",
      "description": "Page number for offset-based pagination (non-negative integer)."
    },
    "per_page": {
      "type": "integer",
      "description": "Number of records to return per page.  Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits."
    },
    "query": {
      "type": "string",
      "description": "The `query` parameter supports the Zendesk search syntax for more advanced user searches. It can specify a partial or full value of any user property, including name, email address, notes, or phone. Example: `query=\"jdoe\"`. See the [Search API](/api-reference/ticketing/ticket-management/search/)."
    },
    "external_id": {
      "type": "string",
      "description": "The `external_id` parameter does not support the search syntax. It only accepts ids."
    },
    "brand_id": {
      "type": "integer",
      "description": "When brand separation is enabled, scopes the search to users belonging to the specified brand. Only applicable when the account has brand separation enabled."
    },
    "include": {
      "type": "string",
      "description": "A comma-separated list of sideloads to include in the response."
    }
  },
  "required": [
    "PCID"
  ]
}

zendesk_users_orgs_show_current_user

Show Self Parameters:

Parameter	Type	Required	Default	Description
`include`	string	No	—	Sideloads to include in the response. Accepts a comma-separated list of values. See Sideloading.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "include": {
      "type": "string",
      "description": "Sideloads to include in the response. Accepts a comma-separated list of values. See [Sideloading](/api-reference/ticketing/users/users/#sideloading)."
    }
  },
  "required": [
    "PCID"
  ]
}

zendesk_users_orgs_show_many_organizations

Show Many Organizations Parameters:

Parameter	Type	Required	Default	Description
`ids`	string	No	—	A list of organization ids
`external_ids`	string	No	—	A list of external ids

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ids": {
      "type": "string",
      "description": "A list of organization ids"
    },
    "external_ids": {
      "type": "string",
      "description": "A list of external ids"
    }
  },
  "required": [
    "PCID"
  ]
}

zendesk_users_orgs_show_many_users

Show Many Users Parameters:

Parameter	Type	Required	Default	Description
`ids`	string	No	—	Accepts a comma-separated list of up to 100 user ids.
`external_ids`	string	No	—	Accepts a comma-separated list of up to 100 external ids.
`include_deleted`	boolean	No	—	If true, returns inactive or deleted users.
`brand_id`	integer	No	—	When brand separation is enabled and `external_ids` is provided, scopes the lookup to users belonging to the specified brand. Only applicable when the account has brand separation enabled.
`include`	string	No	—	Sideloads to include in the response. Accepts a comma-separated list of values. See Sideloading.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ids": {
      "type": "string",
      "description": "Accepts a comma-separated list of up to 100 user ids."
    },
    "external_ids": {
      "type": "string",
      "description": "Accepts a comma-separated list of up to 100 external ids."
    },
    "include_deleted": {
      "type": "boolean",
      "description": "If true, returns inactive or deleted users."
    },
    "brand_id": {
      "type": "integer",
      "description": "When brand separation is enabled and `external_ids` is provided, scopes the lookup to users belonging to the specified brand. Only applicable when the account has brand separation enabled."
    },
    "include": {
      "type": "string",
      "description": "Sideloads to include in the response. Accepts a comma-separated list of values. See [Sideloading](/api-reference/ticketing/users/users/#sideloading)."
    }
  },
  "required": [
    "PCID"
  ]
}

zendesk_users_orgs_show_user_related

Show User Related Information Parameters:

Parameter	Type	Required	Default	Description
`user_id`	integer	Yes	—	The id of the user

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "user_id": {
      "type": "integer",
      "description": "The id of the user"
    }
  },
  "required": [
    "PCID",
    "user_id"
  ]
}

zendesk_users_orgs_update_group

Update Group Parameters:

Parameter	Type	Required	Default	Description
`group_id`	integer	Yes	—	The ID of the group

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "group_id": {
      "type": "integer",
      "description": "The ID of the group"
    }
  },
  "required": [
    "PCID",
    "group_id"
  ]
}

zendesk_users_orgs_update_organization

Update Organization Parameters:

Parameter	Type	Required	Default	Description
`organization_id`	integer	Yes	—	The ID of an organization

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "organization_id": {
      "type": "integer",
      "description": "The ID of an organization"
    }
  },
  "required": [
    "PCID",
    "organization_id"
  ]
}

zendesk_users_orgs_update_user

Update User Parameters:

Parameter	Type	Required	Default	Description
`user_id`	integer	Yes	—	The id of the user
`user`	object	Yes	—	Input schema for updating a user. All fields are optional - only include the fields you want to update.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "user_id": {
      "type": "integer",
      "description": "The id of the user"
    },
    "user": {
      "type": "object",
      "description": "Input schema for updating a user. All fields are optional - only include the fields you want to update.",
      "properties": {
        "agent_brand_ids": {
          "type": "array",
          "items": {
            "type": "integer",
            "format": "int64"
          },
          "description": "The IDs of the brands the agent is assigned to"
        },
        "alias": {
          "type": "string",
          "description": "An alias displayed to end users"
        },
        "custom_role_id": {
          "type": "integer",
          "description": "A custom role if the user is an agent on the Enterprise plan or above"
        },
        "default_group_id": {
          "type": "integer",
          "description": "The id of the user's default group"
        },
        "details": {
          "type": "string",
          "description": "Any details you want to store about the user, such as an address"
        },
        "email": {
          "type": "string",
          "description": "The user's primary email address"
        },
        "external_id": {
          "type": "string",
          "description": "A unique identifier from another system"
        },
        "group_id": {
          "type": "integer",
          "description": "The id of the user's default group. Alias for default_group_id"
        },
        "identities": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "The identities value"
        },
        "language": {
          "type": "string",
          "description": "The user's language preference. Alias for locale."
        },
        "locale": {
          "type": "string",
          "description": "The user's locale. A BCP-47 compliant tag for the locale. If both \"locale\" and \"locale_id\" are present on create or update, \"locale_id\" is ignored and only \"locale\" is used."
        },
        "locale_id": {
          "type": "integer",
          "description": "The user's language identifier"
        },
        "moderator": {
          "type": "boolean",
          "description": "Designates whether the user has forum moderation capabilities"
        },
        "name": {
          "type": "string",
          "description": "The user's name"
        },
        "notes": {
          "type": "string",
          "description": "Any notes you want to store about the user"
        },
        "only_private_comments": {
          "type": "boolean",
          "description": "true if the user can only create private comments"
        },
        "organization_id": {
          "type": "integer",
          "description": "The id of the user's organization"
        },
        "organization_ids": {
          "type": "array",
          "items": {
            "type": "integer",
            "format": "int64"
          },
          "description": "The ids of the user's organizations"
        },
        "phone": {
          "type": "string",
          "description": "The user's primary phone number"
        },
        "photo": {
          "type": "object",
          "description": "The user's profile picture"
        },
        "remote_photo_url": {
          "type": "string",
          "description": "A URL pointing to the user's profile picture"
        },
        "role": {
          "type": "string",
          "description": "The user's role"
        },
        "shared_phone_number": {
          "type": "boolean",
          "description": "Whether the phone number is shared or not"
        },
        "signature": {
          "type": "string",
          "description": "The user's signature. Only agents and admins can have signatures"
        },
        "skip_verify_email": {
          "type": "boolean",
          "description": "If true, the user won't receive a verification email"
        },
        "suspended": {
          "type": "boolean",
          "description": "If the user is suspended"
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "The user's tags"
        },
        "ticket_restriction": {
          "type": "string",
          "description": "Specifies which tickets the user has access to"
        },
        "time_zone": {
          "type": "string",
          "description": "The user's time zone"
        },
        "user_fields": {
          "type": "object",
          "description": "Values of custom fields in the user's profile"
        },
        "verified": {
          "type": "boolean",
          "description": "Any of the user's identities is verified"
        }
      }
    }
  },
  "required": [
    "PCID",
    "user_id",
    "user"
  ]
}

​Tools

​zendesk_users_orgs_autocomplete_organizations

​zendesk_users_orgs_autocomplete_users

​zendesk_users_orgs_count_groups

​zendesk_users_orgs_count_organizations

​zendesk_users_orgs_count_users

​zendesk_users_orgs_create_group

​zendesk_users_orgs_create_or_update_user

​zendesk_users_orgs_create_organization

​zendesk_users_orgs_create_user

​zendesk_users_orgs_delete_group

​zendesk_users_orgs_delete_organization

​zendesk_users_orgs_delete_user

​zendesk_users_orgs_get_group

​zendesk_users_orgs_get_organization

​zendesk_users_orgs_get_user

​zendesk_users_orgs_list_groups

​zendesk_users_orgs_list_organization_users

​zendesk_users_orgs_list_organizations

​zendesk_users_orgs_list_user_groups

​zendesk_users_orgs_list_user_organizations

​zendesk_users_orgs_list_users

​zendesk_users_orgs_organization_related

​zendesk_users_orgs_search_organizations

​zendesk_users_orgs_search_users

​zendesk_users_orgs_show_current_user

​zendesk_users_orgs_show_many_organizations

​zendesk_users_orgs_show_many_users

​zendesk_users_orgs_show_user_related

​zendesk_users_orgs_update_group

​zendesk_users_orgs_update_organization

​zendesk_users_orgs_update_user

Tools

zendesk_users_orgs_autocomplete_organizations

zendesk_users_orgs_autocomplete_users

zendesk_users_orgs_count_groups

zendesk_users_orgs_count_organizations

zendesk_users_orgs_count_users

zendesk_users_orgs_create_group

zendesk_users_orgs_create_or_update_user

zendesk_users_orgs_create_organization

zendesk_users_orgs_create_user

zendesk_users_orgs_delete_group

zendesk_users_orgs_delete_organization

zendesk_users_orgs_delete_user

zendesk_users_orgs_get_group

zendesk_users_orgs_get_organization

zendesk_users_orgs_get_user

zendesk_users_orgs_list_groups

zendesk_users_orgs_list_organization_users

zendesk_users_orgs_list_organizations

zendesk_users_orgs_list_user_groups

zendesk_users_orgs_list_user_organizations

zendesk_users_orgs_list_users

zendesk_users_orgs_organization_related

zendesk_users_orgs_search_organizations

zendesk_users_orgs_search_users

zendesk_users_orgs_show_current_user

zendesk_users_orgs_show_many_organizations

zendesk_users_orgs_show_many_users

zendesk_users_orgs_show_user_related

zendesk_users_orgs_update_group

zendesk_users_orgs_update_organization

zendesk_users_orgs_update_user