--- title: "Retrieve an account" method: GET path: "/api/v1/accounts/{id}" tags: ["Accounts"] --- # Retrieve an account `GET /api/v1/accounts/{id}` Retrieve the details of an account. ## Path parameters - `id` string, required ## Response `200` OK. Request succeeded. - union - object - `object` 'Account', required - `type` 'MOBILE', required - `connection_params` object, required - `im` object, required - `phone_number` string, required - `sim_serial_number` string, required - `call` object, required - `phone_number` string, required - `sim_serial_number` string, required - `last_fetched_at` string — 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. - `id` string, required — A unique identifier. - `name` string, required - `created_at` string, required — 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. - `current_signature` string — A unique identifier. - `signatures` object[] - `title` string, required - `content` string, required - `groups` string[], required - `sources` object[], required - `id` string, required - `status` union, required - 'OK' — The Service is running normally. - 'STOPPED' — The Service has been stopped. - 'ERROR' — The Service has encountered an unspecified error and has been stopped. - 'CREDENTIALS' — Credentials needs to be refreshed for the Service to be able to run. - 'PERMISSIONS' — Some permissions are missing on the host Device for the Service to be able to run. - 'CONNECTING' — The Service is connecting. - object - `object` 'Account', required - `type` 'MAIL', required - `connection_params` object, required - `mail` object, required - `imap_host` string, required - `imap_port` number, required - `imap_user` string, required - `imap_encryption` union - 'tls' - 'ssl' - 'starttls' - 'default' - `smtp_host` string, required - `smtp_port` number, required - `smtp_user` string, required - `id` string, required — A unique identifier. - `name` string, required - `created_at` string, required — 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. - `current_signature` string — A unique identifier. - `signatures` object[] - `title` string, required - `content` string, required - `groups` string[], required - `sources` object[], required - `id` string, required - `status` union, required - 'OK' — The Service is running normally. - 'STOPPED' — The Service has been stopped. - 'ERROR' — The Service has encountered an unspecified error and has been stopped. - 'CREDENTIALS' — Credentials needs to be refreshed for the Service to be able to run. - 'PERMISSIONS' — Some permissions are missing on the host Device for the Service to be able to run. - 'CONNECTING' — The Service is connecting. - object - `object` 'Account', required - `type` 'GOOGLE_OAUTH', required - `connection_params` object, required - `mail` object, required - `id` string, required - `username` string, required - `calendar` object, required - `id` string, required - `username` string, required - `id` string, required — A unique identifier. - `name` string, required - `created_at` string, required — 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. - `current_signature` string — A unique identifier. - `signatures` object[] - `title` string, required - `content` string, required - `groups` string[], required - `sources` object[], required - `id` string, required - `status` union, required - 'OK' — The Service is running normally. - 'STOPPED' — The Service has been stopped. - 'ERROR' — The Service has encountered an unspecified error and has been stopped. - 'CREDENTIALS' — Credentials needs to be refreshed for the Service to be able to run. - 'PERMISSIONS' — Some permissions are missing on the host Device for the Service to be able to run. - 'CONNECTING' — The Service is connecting. - object - `object` 'Account', required - `type` 'ICLOUD', required - `connection_params` object, required - `mail` object, required - `imap_host` string, required - `imap_port` number, required - `imap_user` string, required - `imap_encryption` union - 'tls' - 'ssl' - 'starttls' - 'default' - `smtp_host` string, required - `smtp_port` number, required - `smtp_user` string, required - `id` string, required — A unique identifier. - `name` string, required - `created_at` string, required — 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. - `current_signature` string — A unique identifier. - `signatures` object[] - `title` string, required - `content` string, required - `groups` string[], required - `sources` object[], required - `id` string, required - `status` union, required - 'OK' — The Service is running normally. - 'STOPPED' — The Service has been stopped. - 'ERROR' — The Service has encountered an unspecified error and has been stopped. - 'CREDENTIALS' — Credentials needs to be refreshed for the Service to be able to run. - 'PERMISSIONS' — Some permissions are missing on the host Device for the Service to be able to run. - 'CONNECTING' — The Service is connecting. - object - `object` 'Account', required - `type` 'OUTLOOK', required - `connection_params` object, required - `mail` object, required - `id` string, required - `username` string, required - `calendar` object, required - `id` string, required - `username` string, required - `id` string, required — A unique identifier. - `name` string, required - `created_at` string, required — 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. - `current_signature` string — A unique identifier. - `signatures` object[] - `title` string, required - `content` string, required - `groups` string[], required - `sources` object[], required - `id` string, required - `status` union, required - 'OK' — The Service is running normally. - 'STOPPED' — The Service has been stopped. - 'ERROR' — The Service has encountered an unspecified error and has been stopped. - 'CREDENTIALS' — Credentials needs to be refreshed for the Service to be able to run. - 'PERMISSIONS' — Some permissions are missing on the host Device for the Service to be able to run. - 'CONNECTING' — The Service is connecting. - object - `object` 'Account', required - `type` 'GOOGLE_CALENDAR', required - `connection_params` object, required - `calendar` string, required - `sync_token` string - `id` string, required — A unique identifier. - `name` string, required - `created_at` string, required — 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. - `current_signature` string — A unique identifier. - `signatures` object[] - `title` string, required - `content` string, required - `groups` string[], required - `sources` object[], required - `id` string, required - `status` union, required - 'OK' — The Service is running normally. - 'STOPPED' — The Service has been stopped. - 'ERROR' — The Service has encountered an unspecified error and has been stopped. - 'CREDENTIALS' — Credentials needs to be refreshed for the Service to be able to run. - 'PERMISSIONS' — Some permissions are missing on the host Device for the Service to be able to run. - 'CONNECTING' — The Service is connecting. - object - `object` 'Account', required - `type` 'WHATSAPP', required - `connection_params` object, required - `im` object, required - `phone_number` string, required - `id` string, required — A unique identifier. - `name` string, required - `created_at` string, required — 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. - `current_signature` string — A unique identifier. - `signatures` object[] - `title` string, required - `content` string, required - `groups` string[], required - `sources` object[], required - `id` string, required - `status` union, required - 'OK' — The Service is running normally. - 'STOPPED' — The Service has been stopped. - 'ERROR' — The Service has encountered an unspecified error and has been stopped. - 'CREDENTIALS' — Credentials needs to be refreshed for the Service to be able to run. - 'PERMISSIONS' — Some permissions are missing on the host Device for the Service to be able to run. - 'CONNECTING' — The Service is connecting. - object - `object` 'Account', required - `type` 'LINKEDIN', required - `connection_params` object, required - `im` object, required - `id` string, required - `publicIdentifier` string - `username` string, required - `premiumId` union, required - string - unknown - `premiumContractId` union, required - string - unknown - `premiumFeatures` union[] - union - 'recruiter' - 'sales_navigator' - 'premium' - `organizations` object[], required - `name` string, required - `messaging_enabled` boolean, required - `organization_urn` string, required - `mailbox_urn` string, required - `proxy` object - `source` 'USER', required - `host` string, required - `port` number, required - `protocol` union - 'http' - 'https' - 'socks5' - `username` string - `password` string - `id` string, required — A unique identifier. - `name` string, required - `created_at` string, required — 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. - `current_signature` string — A unique identifier. - `signatures` object[] - `title` string, required - `content` string, required - `groups` string[], required - `sources` object[], required - `id` string, required - `status` union, required - 'OK' — The Service is running normally. - 'STOPPED' — The Service has been stopped. - 'ERROR' — The Service has encountered an unspecified error and has been stopped. - 'CREDENTIALS' — Credentials needs to be refreshed for the Service to be able to run. - 'PERMISSIONS' — Some permissions are missing on the host Device for the Service to be able to run. - 'CONNECTING' — The Service is connecting. - object - `object` 'Account', required - `type` 'SLACK', required - `connection_params` object, required - `im` object, required - `url` string, required - `user` string, required - `user_id` string, required - `team` string, required - `team_id` string, required - `id` string, required — A unique identifier. - `name` string, required - `created_at` string, required — 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. - `current_signature` string — A unique identifier. - `signatures` object[] - `title` string, required - `content` string, required - `groups` string[], required - `sources` object[], required - `id` string, required - `status` union, required - 'OK' — The Service is running normally. - 'STOPPED' — The Service has been stopped. - 'ERROR' — The Service has encountered an unspecified error and has been stopped. - 'CREDENTIALS' — Credentials needs to be refreshed for the Service to be able to run. - 'PERMISSIONS' — Some permissions are missing on the host Device for the Service to be able to run. - 'CONNECTING' — The Service is connecting. - object - `object` 'Account', required - `type` 'TWITTER', required - `connection_params` object, required - `im` object, required - `id` string, required - `username` string, required - `id` string, required — A unique identifier. - `name` string, required - `created_at` string, required — 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. - `current_signature` string — A unique identifier. - `signatures` object[] - `title` string, required - `content` string, required - `groups` string[], required - `sources` object[], required - `id` string, required - `status` union, required - 'OK' — The Service is running normally. - 'STOPPED' — The Service has been stopped. - 'ERROR' — The Service has encountered an unspecified error and has been stopped. - 'CREDENTIALS' — Credentials needs to be refreshed for the Service to be able to run. - 'PERMISSIONS' — Some permissions are missing on the host Device for the Service to be able to run. - 'CONNECTING' — The Service is connecting. - object - `object` 'Account', required - `type` 'EXCHANGE', required - `connection_params` object, required - `mail` object, required - `imap_host` string, required - `imap_port` number, required - `imap_user` string, required - `imap_encryption` union - 'tls' - 'ssl' - 'starttls' - 'default' - `smtp_host` string, required - `smtp_port` number, required - `smtp_user` string, required - `id` string, required — A unique identifier. - `name` string, required - `created_at` string, required — 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. - `current_signature` string — A unique identifier. - `signatures` object[] - `title` string, required - `content` string, required - `groups` string[], required - `sources` object[], required - `id` string, required - `status` union, required - 'OK' — The Service is running normally. - 'STOPPED' — The Service has been stopped. - 'ERROR' — The Service has encountered an unspecified error and has been stopped. - 'CREDENTIALS' — Credentials needs to be refreshed for the Service to be able to run. - 'PERMISSIONS' — Some permissions are missing on the host Device for the Service to be able to run. - 'CONNECTING' — The Service is connecting. - object - `object` 'Account', required - `type` 'TELEGRAM', required - `connection_params` object, required - `im` object, required - `user_id` string, required - `username` string, required - `id` string, required — A unique identifier. - `name` string, required - `created_at` string, required — 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. - `current_signature` string — A unique identifier. - `signatures` object[] - `title` string, required - `content` string, required - `groups` string[], required - `sources` object[], required - `id` string, required - `status` union, required - 'OK' — The Service is running normally. - 'STOPPED' — The Service has been stopped. - 'ERROR' — The Service has encountered an unspecified error and has been stopped. - 'CREDENTIALS' — Credentials needs to be refreshed for the Service to be able to run. - 'PERMISSIONS' — Some permissions are missing on the host Device for the Service to be able to run. - 'CONNECTING' — The Service is connecting. - object - `object` 'Account', required - `type` 'INSTAGRAM', required - `connection_params` object, required - `im` object, required - `id` string, required - `username` string, required - `id` string, required — A unique identifier. - `name` string, required - `created_at` string, required — 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. - `current_signature` string — A unique identifier. - `signatures` object[] - `title` string, required - `content` string, required - `groups` string[], required - `sources` object[], required - `id` string, required - `status` union, required - 'OK' — The Service is running normally. - 'STOPPED' — The Service has been stopped. - 'ERROR' — The Service has encountered an unspecified error and has been stopped. - 'CREDENTIALS' — Credentials needs to be refreshed for the Service to be able to run. - 'PERMISSIONS' — Some permissions are missing on the host Device for the Service to be able to run. - 'CONNECTING' — The Service is connecting. - object - `object` 'Account', required - `type` 'MESSENGER', required - `connection_params` object, required - `im` object, required - `id` string, required - `username` string, required - `id` string, required — A unique identifier. - `name` string, required - `created_at` string, required — 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. - `current_signature` string — A unique identifier. - `signatures` object[] - `title` string, required - `content` string, required - `groups` string[], required - `sources` object[], required - `id` string, required - `status` union, required - 'OK' — The Service is running normally. - 'STOPPED' — The Service has been stopped. - 'ERROR' — The Service has encountered an unspecified error and has been stopped. - 'CREDENTIALS' — Credentials needs to be refreshed for the Service to be able to run. - 'PERMISSIONS' — Some permissions are missing on the host Device for the Service to be able to run. - 'CONNECTING' — The Service is connecting. ## Other responses - `400` — ## Bad Request ### Invalid parameters - Type: "errors/invalid_parameters" One or more request parameters are invalid or missing. ### Missing parameters - Type: "errors/missing_parameters" One or more request parameters are missing. ### Invalid parameters - Type: "errors/invalid_request" One or a combination of request parameters are invalid. ### Malformed request - Type: "errors/malformed_request" The given request has been rejected by the provider. ### Content too large - Type: "errors/content_too_large" The request payload or filter query is too large and has been rejected by the provider. ### Too many characters - Type: "errors/too_many_characters" The provided content exceeds the character limit. ### Unescaped characters - Type: "errors/unescaped_characters" The request path contains unescaped characters. ### Limit too high - Type: "errors/limit_too_high" Provider cannot accept such high pagination limit. See API reference for details. ### Invalid action - Type: "errors/invalid_action" This action is invalid. ### Invalid label - Type: "errors/invalid_label" This label is invalid. - `401` — ## Unauthorized ### Missing credentials - Type: "errors/missing_credentials" Some credentials are necessary to perform the request. ### Multiple sessions - Type: "errors/multiple_sessions" LinkedIn limits the use of multiple sessions on certain Recruiter accounts. This error restricts access to this route only, but causing a popup to appear in the user's browser, prompting them to choose a session, which can disconnect the current account. To avoid this error, use the cookie connection method. ### Wrong account - Type: "errors/wrong_account" The provided credentials do not match the correct account. ### Invalid credentials - Type: "errors/invalid_credentials" The provided credentials are invalid. ### Invalid proxy credentials - Type: "errors/invalid_proxy_credentials" The provided proxy credentials are invalid. ### Invalid IMAP configuration - Type: "errors/invalid_imap_configuration" The provided IMAP configuration is invalid. ### Invalid SMTP configuration - Type: "errors/invalid_smtp_configuration" The provided SMTP configuration is invalid. ### Invalid checkpoint solution - Type: "errors/invalid_checkpoint_solution" The checkpoint resolution did not pass successfully. Please retry. ### Checkpoint error - Type: "errors/checkpoint_error" The checkpoint does not appear to be resolvable. Please try again and contact support if the problem persists. ### Expired credentials - Type: "errors/expired_credentials" Invalid credentials. Please check your username and password and try again. ### Expired link - Type: "errors/expired_link" This link has expired. Please return to the application and generate a new one. ### Insufficient privileges - Type: "errors/insufficient_privileges" This resource seems to be out of your scopes. ### Disconnected account - Type: "errors/disconnected_account" The account appears to be disconnected from the provider service. ### Disconnected feature - Type: "errors/disconnected_feature" The service you're trying to reach appears to be disconnected. - `404` — ## Not Found ### Resource not found. The requested resource were not found. Account not found - `500` — ## Internal Server Error ### Unexpected error - Type: "errors/unexpected_error" Something went wrong. {{moreDetails}} ### Provider error - Type: "errors/provider_error" The provider is experiencing operational problems. Please try again later. ### Authentication intent error - Type: "errors/authentication_intent_error" The current authentication intent was killed after failure. Please start the process again from the beginning. - `503` — ## Service Unavailable ### No client session - Type: "errors/no_client_session" No client session is currently running. ### No channel - Type: "errors/no_channel" No channel to client session. ### Handler missing - Type: "errors/no_handler" Handler missing for that request. ### Network down - Type: "errors/network_down" Network is down on server side. Please wait a moment and retry. ### Service unavailable - Type: "errors/service_unavailable" Please try again later. - `504` — ## Gateway Timeout ### Request timed out - Type: "errors/request_timeout" Request Timeout. Please try again, and if the issue persists, contact support. --- [API](https://skmtc.net/unipile/apis/unipile-api-reference.md) · [All operations](https://skmtc.net/unipile/apis/unipile-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/unipile/unipile-api-reference/revisions/3483a34061f6/schema)