myMachineUser

QUERY

myMachineUser: MachineUser

Returns

MachineUser

ID!

fullName

String!

Internal display name, visible only to workspace members.

publicName

String!

Customer-facing name shown when the machine user interacts with customers (e.g. sends messages).

description

String

type

MachineUserType!

The type of machine user. Defaults to API_USER if not specified during creation.

isCustomAgent

Boolean!

True when this machine user is an agent the workspace built itself, rather than an ordinary API integration.

avatar

WorkspaceFile

apiKey

ApiKey

Fetches a single API key belonging to this machine user by its ID.

Arguments

apiKeyId

ID!

required

apiKeys

ApiKeyConnection!

Paginated list of all API keys belonging to this machine user.

Arguments

first

Int

after

String

last

Int

before

String

createdBy

createdAt

updatedBy

updatedAt

isDeleted

Boolean!

True if the machine user has been deleted. Deleted machine users lose all their API keys and can no longer authenticate.

deletedAt

DateTime

deletedBy

Actor

Query

query MyMachineUser {
  myMachineUser {
    id
    fullName
    publicName
    description
    type
    isCustomAgent
  }
}

Response

{
  "data": {
    "myMachineUser": {
      "id": "id",
      "fullName": "string",
      "publicName": "string",
      "description": "string",
      "type": "API_USER",
      "isCustomAgent": true
    }
  }
}

⌘I

Query

query MyMachineUser {
  myMachineUser {
    id
    fullName
    publicName
    description
    type
    isCustomAgent
  }
}

Response

{
  "data": {
    "myMachineUser": {
      "id": "id",
      "fullName": "string",
      "publicName": "string",
      "description": "string",
      "type": "API_USER",
      "isCustomAgent": true
    }
  }
}

Queries

Mutations

Types

Returns