Merge · Schema

User

# The User Object ### Description The `User` object is used to represent a user within the Chat account. ### Usage Example Fetch from the `GET /api/chat/v1/users` endpoint and view their users.

IntegrationsPlatformUnified APIAgent HandlerLLM Gateway

Properties

Name	Type	Description
id	string
remote_id	stringnull	The third-party API ID of the matching object.
created_at	string	The datetime that this object was created by Merge.
modified_at	string	The datetime that this object was modified by Merge.
username	stringnull	Username or handle
display_name	stringnull	Full name or display name
first_name	stringnull	The user's first name
last_name	stringnull	The user's last name
is_bot	booleannull	Returns true if the user is a bot
groups	array
avatar	stringnull	The user's avatar image
remote_created_at	stringnull	When the third party's user was created.
remote_updated_at	stringnull	When the third party's user was updated.
remote_was_deleted	boolean	Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited cove
field_mappings	object
remote_data	arraynull

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/User",
  "title": "User",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "remote_id": {
      "type": [
        "string",
        "null"
      ],
      "description": "The third-party API ID of the matching object."
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime that this object was created by Merge."
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime that this object was modified by Merge."
    },
    "username": {
      "type": [
        "string",
        "null"
      ],
      "description": "Username or handle"
    },
    "display_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "Full name or display name"
    },
    "first_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "The user's first name"
    },
    "last_name": {
      "type": [
        "string",
        "null"
      ],
      "description": "The user's last name"
    },
    "is_bot": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "Returns true if the user is a bot"
    },
    "groups": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      }
    },
    "avatar": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "description": "The user's avatar image"
    },
    "remote_created_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When the third party's user was created."
    },
    "remote_updated_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "When the third party's user was updated."
    },
    "remote_was_deleted": {
      "type": "boolean",
      "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)."
    },
    "field_mappings": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/UserFieldMappings"
        },
        {
          "type": "null"
        }
      ]
    },
    "remote_data": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/components/schemas/RemoteData"
      }
    }
  },
  "description": "# The User Object\n### Description\nThe `User` object is used to represent a user within the Chat account.\n\n### Usage Example\nFetch from the `GET /api/chat/v1/users` endpoint and view their users."
}