query MachineUser($machineUserId: ID!) {
machineUser(machineUserId: $machineUserId) {
id
fullName
publicName
description
type
isCustomAgent
}
}{
"machineUserId": "id"
}{
"data": {
"machineUser": {
"id": "id",
"fullName": "string",
"publicName": "string",
"description": "string",
"type": "API_USER",
"isCustomAgent": true
}
}
}machineUser
Fetches a single machine user by ID. Returns null if no machine user with the given ID exists in the workspace. Deleting a machine user, and creating, changing or deleting its API keys, are done by the user in the Plain app, so a key’s secret never passes through an agent. Get this workspace’s ID and give the user the full link with that ID in it, https://app.plain.com/workspace/w_…/settings/machine-users/<machineUserId> (never the <workspaceId> placeholder), or …/api-keys/add and …/api-keys/<apiKeyId> under it for keys.
machineUser(machineUserId: ID!): MachineUserArguments
Returns
Internal display name, visible only to workspace members.
Customer-facing name shown when the machine user interacts with customers (e.g. sends messages).
The type of machine user. Defaults to API_USER if not specified during creation.
True when this machine user is an agent the workspace built itself, rather than an ordinary API integration.
False when custom-agent pricing is on for the workspace and this machine user is neither a custom agent nor the Customer Agent. Such a machine user cannot be assigned to a thread. True means the agent rule does not refuse this machine user; other gates, such as credits, can still refuse an assignment.
Fetches a single API key belonging to this machine user by its ID.
Paginated list of all API keys belonging to this machine user.
True if the machine user has been deleted. Deleted machine users lose all their API keys and can no longer authenticate.
query MachineUser($machineUserId: ID!) {
machineUser(machineUserId: $machineUserId) {
id
fullName
publicName
description
type
isCustomAgent
}
}{
"machineUserId": "id"
}{
"data": {
"machineUser": {
"id": "id",
"fullName": "string",
"publicName": "string",
"description": "string",
"type": "API_USER",
"isCustomAgent": true
}
}
}Was this page helpful?

