--- title: "Get user info" method: GET path: "/user" --- # Get user info `GET /user` ## Request - Base URL: `https://api.signnow.com` - URL: `https://api.signnow.com/user` - Auth: HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) This endpoint allows API users to get information about the current user. ## Response `200` Details of the user account. - object - `id` string: ID of the user. - `pro` integer: Legacy flag of a paid account: `1` or `0`. - `type` integer: Account type. - `teams` object[]: Teams the user belongs to. - `id` string: ID of the team. - `role` string: User's role in the team: `admin` or `member`. - `team` string: Name of the team. - `type` string: Team type: `VIEWABLE` or `SHAREABLE`. - `admins` object[]: Team admins. - `id` string: Internal ID of the admin. - `email` string: Email address of the admin. - `billing` integer: Whether the admin manages billing: `1` for yes, `0` for no. - `primary` boolean: Whether the admin is the primary admin. - `is_secondary` string: `1` if the admin is a secondary admin, `0` otherwise. - `document_access` integer: Whether the admin has access to team documents: `1` for yes, `0` for no. - `team_options` object: Team options. - `support_template_sl` boolean: Whether templates of the team support signing links. - `hide_doc_copy_options` boolean: Whether options to copy documents are hidden for team members. - `team_default_document_folder` string: ID of the default folder for team documents. An empty string if none is set. - `workspace_id` string: ID of the workspace the team belongs to. `null` if the team is not linked to a workspace. - `created_since` string: Unix timestamp of when the team was created, as a string. - `document_count` integer: Number of documents in the team. - `team_owner_full_name` string: Full name of the team owner. The email address if no name is set. - `active` string: Whether the account is active: `1` for active, `0` for inactive. - `emails` string[]: Email addresses of the user. - `locale` string: Language of the account, for example `en`. - `status` object: Status of connected external accounts. - `bad_copy_token` boolean: Whether the copy token is invalid. - `has_copy_token` boolean: Whether a copy token is set. - `has_salesforce_token` boolean: Whether a Salesforce account is connected. - `bad_cloud_export_token` boolean: Whether the cloud export token is invalid. - `has_cloud_export_token` boolean: Whether a cloud export account is connected. - `created` string: Unix timestamp of when the account was created, as a string. - `credits` integer: Number of document credits. - `settings` object: Account settings as boolean flags, keyed by setting name. The set of settings depends on the account and plan. - `verified` boolean: Whether the email address of the user is verified. - `appleapps` boolean: Whether the account is connected to Apple. - `companies` object[]: Companies the user belongs to. - `name` string: Name of the company. - `full_access` boolean: Whether the user has full access to the company. - `last_name` string: Last name of the user. - `avatar_url` string: URL of the user avatar. `null` if none is set. - `first_name` string: First name of the user. - `googleapps` boolean: Whether the account is connected to Google. - `facebookapps` boolean: Whether the account is connected to Facebook. - `is_logged_in` boolean: Whether the user is logged in. - `organization` object: Organization the user belongs to. - `id` string: ID of the organization. - `name` string: Name of the organization. - `logos` object[]: Logos of the organization. - `teams` object[]: Teams of the organization. - `id` string: ID of the team. - `name` string: Name of the team. - `active` boolean: Whether the organization is active. - `created` string: Unix timestamp of when the organization was created, as a string. - `deleted` string: `1` if the organization is deleted, `0` otherwise. - `domains` string[]: Email domains of the organization. - `updated` string: Unix timestamp of the last update, as a string. - `is_admin` boolean: Whether the user is an admin of the organization. - `has_admin` boolean: Whether the organization has an admin. - `active_logo` object[]: Active logo of the organization. - `is_workspace` boolean: Whether the organization is a workspace. - `is_superadmin` boolean: Whether the user is the super admin of the organization. - `has_active_sso_configuration` boolean: Whether single sign-on is configured for the organization. - `microsoftapps` boolean: Whether the account is connected to Microsoft. - `primary_email` string: Primary email address of the user. - `subscriptions` object[]: The user's subscriptions. - `id` string: ID of the subscription. - `name` string: Internal name of the subscription plan. - `plan` string: Plan level, for example `business` or `enterprise`. - `term` integer: Subscription term, in months. - `seats` integer: Number of seats in the subscription. - `trial` boolean: Whether the subscription is a trial. - `addons` object[]: Add-ons of the subscription. - `created` integer: Unix timestamp of when the subscription was created. - `expired` integer: Unix timestamp of when the subscription expires. - `updated` integer: Unix timestamp of the last update. - `seat_role` string: User's role in the subscription, for example `super_admin`, `admin`, or `user`. - `used_seats` integer: Number of seats in use. - `credit_card` boolean: Whether the subscription is paid by credit card. - `is_freemium` boolean: Whether the subscription is a free plan. - `plan_version` integer: Version of the plan. - `billing_cycle` integer: Billing cycle, in months. - `is_usage_based` boolean: Whether the subscription is usage-based. - `subscription_id` string: ID of the subscription. Same as `id`. - `mobile_plan_type` string: Mobile plan type. An empty string if there is none. - `seat_admin_email` string: Email address of the subscription admin. - `gateway_subscription` object: Payment gateway details of the subscription. - `gateway` string: Payment gateway. `null` if the subscription is not billed through a gateway. - `auto_renew` boolean: Whether the subscription renews automatically. - `is_usage_based_seat_free` boolean: Whether the subscription is usage-based without seats. - `is_seat_free_subscription` boolean: Whether the subscription has no seat limit. - `billing_period` object: Current billing period. - `end_date` string: End date, in `MM/DD/YYYY` format. - `start_date` string: Start date, in `MM/DD/YYYY` format. - `end_timestamp` integer: Unix timestamp of the end. - `start_timestamp` integer: Unix timestamp of the start. - `document_count` integer: Number of documents the user has. - `premium_access` object: Access the user has through their subscription. - `api` object: API access of the user. - `key` string: API subscription key. - `level` string: API plan level. - `is_trial` boolean: Whether API access is a trial. - `plan_name` string: Internal name of the API plan. - `created_at` integer: Unix timestamp of when API access started. - `expired_at` integer: Unix timestamp of when API access expires. - `plan` string: Plan level, for example `business` or `enterprise`. - `seat` object: Seat details. - `role` string: User's role in the subscription, for example `super_admin`, `admin`, or `user`. - `user` object: Seat of the user in the subscription. - `admin` string: Email address of the subscription admin. - `email` string: Email address of the user. - `status` string: Status of the seat, for example `Added`. - `username` string: Username, the same as the email address. - `last_name` string: Last name. - `added_date` integer: Unix timestamp of when the user was added to the subscription. - `first_name` string: First name. - `error` boolean: Whether an error occurred while checking access. - `trial` boolean: Whether the subscription is a trial. - `active` boolean: Whether the user has an active subscription. - `business` boolean: Whether the plan is a Business plan. - `credit_card` boolean: Whether the subscription is paid by credit card. - `subscription` object: Subscription details. - `key` string: Subscription key. - `name` string: Internal name of the subscription plan. - `plan` object: Plan of the subscription. - `id` integer: Internal ID of the plan. - `name` string: Display name of the plan. - `type` string: Plan type, for example `web`. - `level` string: Plan level, for example `business` or `enterprise`. - `price` integer: Price of the plan. - `groups` string[]: Feature groups included in the plan. - `plan_id` string: Internal name of the plan. - `is_trial` boolean: Whether the plan is a trial. - `billing_cycle` integer: Billing cycle, in months. - `is_marketplace` boolean: Whether the plan was bought on a marketplace. - `mobile_plan_type` string: Mobile plan type. `null` if there is none. - `term` integer: Subscription term, in months. - `seats` integer: Number of seats. - `addons` object[]: Add-ons of the subscription. - `status` string: Status of the subscription, for example `active`. - `version` integer: Version of the subscription. - `corporate` boolean: Whether the subscription is a corporate subscription. - `created_at` integer: Unix timestamp of when the subscription was created. - `expired_at` integer: Unix timestamp of when the subscription expires. - `updated_at` integer: Unix timestamp of the last update. - `used_seats` integer: Number of seats in use. - `admin_email` string: Email address of the subscription admin. - `marketplace` object: Marketplace the subscription was bought on. - `name` string: Name of the marketplace. `null` if the subscription was not bought on a marketplace. - `cancelled_at` integer: Unix timestamp of when the subscription was cancelled. `null` if not cancelled. - `trial_period` object: Trial period details. `null` if the subscription is not a trial. - `serial_number` string: Serial number of the subscription. - `in_grace_period` boolean: Whether the subscription is in its grace period after expiry. - `gateway_subscription` object: Payment gateway details of the subscription. - `gateway` string: Payment gateway. `null` if the subscription is not billed through a gateway. - `auto_renew` boolean: Whether the subscription renews automatically. - `grace_period_expires_at` integer: Unix timestamp of when the grace period ends. `null` if not in a grace period. - `has_delayed_subscription` boolean: Whether a subscription is scheduled to start later. - `is_scim_managed` boolean: Whether the account is managed through SCIM. - `password_changed` integer: Unix timestamp of the last password change. - `merchant_accounts` object[]: Payment merchant accounts connected to the user. - `id` string: ID of the merchant account. - `scope` string: Scope of the merchant account, for example `user`. - `currency` string: Default currency code, for example `USD`. - `currencies` string[]: Currencies the merchant account supports. - `currency_name` string: Name of the default currency. - `merchant_type` string: Payment provider of the merchant account. - `merchant_account_name` string: Name of the merchant account. - `has_atticus_access` boolean: Whether the user has access to Atticus. - `issue_notifications` object[]: Account notifications that need attention. - `registration_source` string: Source the account was registered from. `null` if unknown. - `signer_phone_invite` object: Phone invite details of the user. `null` if none. - `application_settings` object: Settings of the application the request was made with. Each value is `null` if not set. - `embedded_sending_close_button_text` string: Text of the close button in embedded sending. - `embedded_sending_close_button_visible` boolean: Whether the close button is shown in embedded sending. - `embedded_sending_continue_button_text` string: Text of the continue button in embedded sending. - `embedded_sending_continue_button_visible` boolean: Whether the continue button is shown in embedded sending. - `embedded_editor_session_close_button_text` string: Text of the close button in the embedded editor. - `organization_settings` object[]: Settings of the organization the user belongs to. - `value` string: Value of the setting, as a string. - `setting` string: Name of the setting. - `modified_primary_email` string: Primary email address after the last change. The same as `primary_email` if it was not changed. - `monthly_document_count` string: Number of documents the user has created this month, as a string. - `lifetime_document_count` integer: Number of documents the user has created since the account was opened. - `cloud_export_account_details` object: Details of the connected cloud export account. `null` if none is connected. ## Other responses - `400`: Request with incorrect or missing token. --- [API](https://skmtc.dev/signnow/apis/signnow-api.md) - [All operations](https://skmtc.dev/signnow/apis/signnow-api/llms.txt) - [OpenAPI document](https://skmtc.dev/signnow/apis/signnow-api/revisions/1c9c30a6142b?raw)