Unipile: Get Account

Get one connected Unipile account by account_id, including its channel type and connection status.

Tool ID: unipile_get_account

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'unipile_get_account',
  {
    "id": "id_123"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute unipile_get_account --input '{
  "id": "id_123"
}' --json

Example response

The static output schema lacks the details for a reliable example. Use deepline describe unipile_get_account --json for the complete live contract.

Input reference

Retrieve the details of an account. For a pending UniLogin checkpoint, poll this route every 2 seconds with its account_id: 404 means the account connection is still pending. 200 returns the usual Account once completed.

Name	Type	Required	Default	Details
`payload.id`	`string`	Yes	—	The id of the account to retrieve.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.object`	`"Account"`	Yes	—	—
`result.data.type`	`"MOBILE"`	Yes	—	—
`result.data.connection_params`	`object`	Yes	—	—
`result.data.connection_params.im`	`object`	Yes	—	—
`result.data.connection_params.im.phone_number`	`string`	Yes	—	—
`result.data.connection_params.im.sim_serial_number`	`string`	Yes	—	—
`result.data.connection_params.call`	`object`	Yes	—	—
`result.data.connection_params.call.phone_number`	`string`	Yes	—	—
`result.data.connection_params.call.sim_serial_number`	`string`	Yes	—	—
`result.data.last_fetched_at`	`unknown`	No	—	An ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ). ⚠️ All links expire upon daily restart, regardless of their stated expiration date. A new link must be generated each time a user clicks on your app to connect.
`result.data.id`	`string`	Yes	—	A unique identifier.
`result.data.name`	`string`	Yes	—	—
`result.data.created_at`	`unknown`	Yes	—	An ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ). ⚠️ All links expire upon daily restart, regardless of their stated expiration date. A new link must be generated each time a user clicks on your app to connect.
`result.data.current_signature`	`string`	No	—	A unique identifier.
`result.data.signatures`	`array`	No	—	—
`result.data.signatures[].title`	`string`	Yes	—	—
`result.data.signatures[].content`	`string`	Yes	—	—
`result.data.groups`	`array`	Yes	—	—
`result.data.sources`	`array`	Yes	—	—
`result.data.sources[].id`	`string`	Yes	—	—
`result.data.sources[].status`	`"OK" \| "STOPPED" \| "ERROR" \| "CREDENTIALS" \| "PERMISSIONS" \| "CONNECTING"`	Yes	—	—
`result.data.connection_params.mail`	`object`	Yes	—	—
`result.data.connection_params.mail.imap_host`	`string`	Yes	—	—
`result.data.connection_params.mail.imap_port`	`number`	Yes	—	—
`result.data.connection_params.mail.imap_user`	`string`	Yes	—	—
`result.data.connection_params.mail.imap_encryption`	`"tls" \| "ssl" \| "starttls" \| "default"`	No	—	—
`result.data.connection_params.mail.smtp_host`	`string`	Yes	—	—
`result.data.connection_params.mail.smtp_port`	`number`	Yes	—	—
`result.data.connection_params.mail.smtp_user`	`string`	Yes	—	—
`result.data.connection_params.mail.id`	`string`	Yes	—	—
`result.data.connection_params.mail.username`	`string`	Yes	—	—
`result.data.connection_params.calendar`	`object`	Yes	—	—
`result.data.connection_params.calendar.id`	`string`	Yes	—	—
`result.data.connection_params.calendar.username`	`string`	Yes	—	—
`result.data.connection_params.mail.mailbox_id`	`string`	No	—	—
`result.data.connection_params.calendar.mailbox_id`	`string`	No	—	—
`result.data.sync_token`	`string`	No	—	—
`result.data.connection_params.im.id`	`string`	Yes	—	—
`result.data.connection_params.im.connection_method`	`"credentials" \| "cookies" \| "unilogin"`	No	—	—
`result.data.connection_params.im.last_visited_page`	`object`	No	—	—
`result.data.connection_params.im.last_visited_page.url`	`string`	Yes	—	—
`result.data.connection_params.im.last_visited_page.visited_at`	`unknown`	Yes	—	An ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ). ⚠️ All links expire upon daily restart, regardless of their stated expiration date. A new link must be generated each time a user clicks on your app to connect.
`result.data.connection_params.im.publicIdentifier`	`string`	No	—	—
`result.data.connection_params.im.username`	`string`	Yes	—	—
`result.data.connection_params.im.premiumId`	`string \| null`	Yes	—	—
`result.data.connection_params.im.premiumContractId`	`string \| null`	Yes	—	—
`result.data.connection_params.im.premiumFeatures`	`array`	No	—	—
`result.data.connection_params.im.organizations`	`array`	Yes	—	—
`result.data.connection_params.im.organizations[].name`	`string`	Yes	—	—

The table shows the first 50 fields. Use the live contract below for every field.

This output schema is too large for an inline display. Read the complete live contract with deepline describe unipile_get_account --json.

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation