GET: Users Ingrid https://api.bitsighttech.com/ratings/v2/users Get the users within your Bitsight account. See permissions. Parameters See query parameters for details on the following parameters: limit (Default: ↻ 100) offset (Default ↻ 100) q – See response attributes. sort email [Query] Filter by the user’s email address. Value: [String] email_q [Query] Search by the user’s email address. Value: [String] formal_name_q [Query] Search by the user’s full name. Value: [String] group.guid [Query] Filter the Access Control Group of the user. Value: [Array] Comma-separated group unique identifiers [group_guid]. See GET: Access Control Groups. guid [Query] Filter by a specific user. Value: [String] User unique identifier [user_guid]. is_available_for_contact [Query] Filter by subscription contact. Value: [Boolean] true = Include subscription contacts. is_company_api_token [Query] Filter by actual users or user accounts for the company API token. Value: [Boolean] true = Include user accounts that are company API tokens. roles.slug [Query] Filter by user role. Value: [Array] Comma-separated user role slug name. See user roles. status [Query] Filter by user account status. Value: [Array] Comma-separated user account status. Activated Created Deactivated Example Request curl 'https://api.bitsighttech.com/ratings/v2/users' -u api_token: Example Response { "links":{ "next":"https://api.bitsighttech.com/ratings/v2/users?limit=100&offset=200", "previous":"https://api.bitsighttech.com/ratings/v2/users?limit=100" }, "count":123, "results":[ { "guid":"33333333-dddd-3333-dddd-dddddddddddd", "friendly_name":"Diane Jones", "formal_name":"Diane Jones", "email":"diane@actorsfilms.us", "group":{ "guid":"dddddddd-3333-dddd-3333-dddddddddddd", "name":"Central Pacific" }, "landing_page":"DEFAULT", "status":"Activated", "last_login_time":"2021-01-29T20:44:53.879238Z", "joined_time":"2020-07-16T21:11:23Z", "roles":[ { "name":"Admin", "slug":"customer_admin" } ], "is_available_for_contact":false, "is_company_api_token":false, "features":[ { "slug":"wfh-ro", "value":true, "can_update":false } ], "preferred_contact_for_entities":[ "1b3d260c-9e23-4e19-b3a5-a0bcf67d74d9" ], "mfa_status":"not_enabled" } ] } Response Attributes Field Description links Object Navigation for multiple pages of results. See pagination. next String The URL for navigating to the next page of results. previous String The URL for navigating to the previous page of results. count Integer The number of users. results Array User details. Object A user. guid String [user_guid] The unique identifier of this user. friendly_name String The preferred name of this user. formal_name String The full name of this user. email String The email address of this user. group Object Access Control Group details of this user. guid String [group_guid] The unique identifier of this group. name String The name of this group. landing_page String The landing page set by this user when first logging in to the Bitsight platform. Switching to an application negates this configuration. Values: DEFAULT SPM = The My Company Dashboard. TPRM = The Portfolio Dashboard. status String The account status of this user. last_login_time String [YYYY‑MM‑DDTHH:MM:SSZ] The date and time when this user last logged in to the Bitsight platform. joined_time String [YYYY‑MM‑DDTHH:MM:SSZ] The date and time when this user was added to the Bitsight platform. roles Array The roles of this user. See user roles. Object A user role. name String The name of this role. slug String The slug name of this role. is_available_for_contact Boolean true = This user is assigned as a subscription contact to be notified when other users request to add companies to the portfolio. is_company_api_token Boolean true = This user account is a company API token and is not an actual user. features Array User-managed feature details of this user. See features. Object A feature. slug String The slug name of this feature. value Boolean true = This feature is enabled for this user. can_update Boolean true = This user can manage settings for this feature. preferred_contact_for_entities Array [entity_guid] Companies where this user is their preferred contact. mfa_status String The multi-factor or 2-factor authentication (2FA) status of this user. Values: enabled = 2FA is enabled for this user. not_enabled = 2FA is not enabled for this user. pending = An Admin enforced 2FA for this user and the user has not configured 2FA yet. Jaunary 3, 2025: Linked to user management permissions; Linked to subscription contact definition; Linked to enforced 2FA information and configuration instructions. August 25, 2021: Added landing_page, preferred_contact_for_entities, & mfa_status fields. May 26, 2020: Published. Related articles Users API Endpoint User Roles GET: User Details Parameters Action Plans: Control Insights Feedback 0 comments Please sign in to leave a comment.