Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.blinkops.com/llms.txt

Use this file to discover all available pages before exploring further.

Get all user records.
External DocumentationTo learn more, visit the AuditBoard documentation.

Parameters

ParameterDescription
IncludeSpecify which optional data fields to include in the response.

Example Output

{
	"users": [
		{
			"id": 2,
			"_permissions": {
				"action.administer": true
			},
			"created_at": "2001-12-06T12:07:23.693Z",
			"updated_at": "2022-12-14T06:59:04.787Z",
			"deleted_at": null,
			"core_modules": [],
			"first_name": "<string>",
			"last_name": "<string>",
			"avatar_key": null,
			"avatar_signed_url": "<string>",
			"username": "<string>",
			"job_title": null,
			"employee_number": null,
			"login_attempt": 0,
			"last_login_failed_attempt": "2006-05-28T09:14:51.043Z",
			"account_expiration_date": null,
			"email": "<string>",
			"accepted_terms": true,
			"api_user_last_login": null,
			"requires_password_change": null,
			"icon_bg_color": "<string>",
			"icon_fg_color": "<string>",
			"auth_type": "<string>",
			"slack_user_id": null,
			"sent_slack_welcome_notification": null,
			"azure_conversation_data": null,
			"ext_api_federated_rules": {
				"domain": "<string>",
				"enabled": false
			},
			"teams_notifications_enabled": null,
			"cell_phone": "<string>",
			"mfa_enabled": false,
			"chameleon_identifier": null,
			"has_external_api_token": false,
			"scim_user_active": "<string>",
			"full_name": "<string>",
			"initials": "<string>",
			"locale": null,
			"team_ids": [],
			"role_id": 0,
			"department_id": null,
			"location_id": null
		},
		{
			"id": 4,
			"_permissions": {
				"action.administer": true,
				"action.view": true,
				"action.edit": true
			},
			"created_at": "2015-10-06T03:09:13.201Z",
			"updated_at": "2000-03-25T15:54:14.538Z",
			"deleted_at": "2016-02-16T19:33:38.766Z",
			"core_modules": [],
			"first_name": "<string>",
			"last_name": "<string>",
			"avatar_key": "<string>",
			"avatar_signed_url": "<string>",
			"username": "<string>",
			"job_title": "<string>",
			"employee_number": "<string>",
			"login_attempt": 2,
			"last_login_failed_attempt": null,
			"account_expiration_date": null,
			"email": "<string>",
			"accepted_terms": false,
			"api_user_last_login": null,
			"requires_password_change": false,
			"icon_bg_color": "<string>",
			"icon_fg_color": "<string>",
			"auth_type": "<string>",
			"slack_user_id": null,
			"sent_slack_welcome_notification": false,
			"azure_conversation_data": null,
			"ext_api_federated_rules": {
				"domain": "<string>",
				"enabled": false
			},
			"teams_notifications_enabled": false,
			"cell_phone": "<string>",
			"mfa_enabled": false,
			"chameleon_identifier": "<string>",
			"has_external_api_token": false,
			"scim_user_active": "<string>",
			"full_name": "<string>",
			"initials": "<string>",
			"locale": null,
			"team_ids": [],
			"role_id": 1,
			"department_id": null,
			"location_id": null
		}
	],
	"teams": [
		{
			"id": 12,
			"_permissions": {
				"action.view": true,
				"action.delete": true,
				"action.create": true,
				"action.edit": true
			},
			"created_at": "2006-08-04T17:07:03.957Z",
			"updated_at": "2014-08-19T00:15:12.447Z",
			"deleted_at": null,
			"name": "<string>",
			"uid": "<string>",
			"sort_order": 2,
			"description": "<string>"
		},
		{
			"id": 8,
			"_permissions": {
				"action.view": true,
				"action.delete": true,
				"action.create": true,
				"action.edit": true
			},
			"created_at": "2004-05-13T08:23:50.892Z",
			"updated_at": "2002-09-05T02:52:33.536Z",
			"deleted_at": null,
			"name": "<string>",
			"uid": "<string>",
			"sort_order": 12,
			"description": "<string>"
		}
	],
	"meta": {
		"resourceNames": {
			"dasherized": "<string>",
			"camelized": "<string>"
		}
	}
}

Workflow Library Example

Get Users with Auditboard and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop