Users

User management and invitations

Get user profile

get

Retrieve information about the authenticated user. This endpoint is only available with user-scoped authentication.

Authorizations

AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Responses

200

User profile details

application/json

idinteger · int64Required

User ID

Example: 101

namestringOptional

User name

Example: John Doe

emailstring · emailRequired

User email

Example: [email protected]

titlestringOptional

User title

Example: Senior Engineer

nickNamestringOptional

User nickname

Example: Johnny

phoneNumberstringOptional

User phone number

Example: +11234567890

orgIdinteger · int32Required

Organization ID, that the user belongs to

Example: 101

orgNamestringOptional

Organization name

Example: Acme Corp

tzstringOptional

User timezone in the IANA Time Zone Database (TZDB) format.

Example: Europe/Kyiv

localestringOptional

User locale.

Example: en_US

statusstring · enumRequired

User status

Possible values:

lastModifiedTsinteger · int64Required

Timestamp, indicating the time, when the user was modified last time (Unix epoch milliseconds)

Example: 1707244800000

lastLoggedAtinteger · int64Optional

Timestamp, when the user has logged in last time (Unix epoch milliseconds)

Example: 1707244800000

registeredAtinteger · int64Required

Timestamp, when the user has registered (Unix epoch milliseconds)

Example: 1707244800000

isDevbooleanRequired

Whether the user has enabled the developer mode

Example: true

isDarkModebooleanRequired

Whether the user has enabled dark mode

Example: false

403

Forbidden - This endpoint requires user-scoped authentication

application/json

429

Too many requests

500

Internal server error

application/json

get

/api/v1/organization/user/profile

GET /api/v1/organization/user/profile HTTP/1.1
Host: blynk.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 101,
  "name": "John Doe",
  "email": "[email protected]",
  "title": "Senior Engineer",
  "nickName": "Johnny",
  "phoneNumber": "+11234567890",
  "role": {
    "id": 1,
    "name": "Admin",
    "permissions": [
      "ORG_VIEW",
      "ORG_DEVICES_VIEW"
    ]
  },
  "orgId": 101,
  "orgName": "Acme Corp",
  "tz": "Europe/Kyiv",
  "locale": "en_US",
  "status": "Pending",
  "lastModifiedTs": 1707244800000,
  "lastLoggedAt": 1707244800000,
  "registeredAt": 1707244800000,
  "isDev": true,
  "isDarkMode": false
}

Get users in organization

get

Retrieve a paginated list of users in the organization, associated with the authentication token.

Required permissions, when user-scoped authentication is used: ORG_VIEW_USERS.

Authorizations

AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Query parameters

includeSubOrgUsersbooleanOptional

Include users from sub-organizations

Default: false

pageinteger · int32Optional

Page number (0-indexed)

Default: 0

sizeinteger · int32 · min: 1 · max: 1000Optional

Page size (max 1000)

Default: 50

Responses

200

List of users

application/json

totalElementsinteger · int64OptionalExample: 1

400

Bad request

application/json

403

Forbidden

429

Too many requests

500

Internal server error

application/json

get

/api/v1/organization/users

GET /api/v1/organization/users HTTP/1.1
Host: blynk.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "content": [
    {
      "id": 101,
      "name": "John Doe",
      "email": "[email protected]",
      "roleId": 1,
      "orgId": 101,
      "isDev": true
    }
  ],
  "totalElements": 1
}

Search users

get

Search for users by the provided query.

Required permissions, when user-scoped authentication is used: ORG_VIEW_USERS.

Authorizations

AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Query parameters

querystring · max: 255Required

Search query string

sortBystringOptional

Field to sort by

sortOrderstring · enumOptional

Sort order

Default: ASCPossible values:

pageinteger · int32Optional

Page number (0-indexed)

Default: 0

sizeinteger · int32 · min: 1 · max: 1000Optional

Page size (max 1000)

Default: 50

Responses

200

Search results

application/json

totalElementsinteger · int64Required

Total amount of users, available to fetch.

Example: 1

400

Bad request

application/json

403

Forbidden

429

Too many requests

500

Internal server error

application/json

get

/api/v1/organization/search/users

GET /api/v1/organization/search/users?query=text HTTP/1.1
Host: blynk.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "content": [
    {
      "id": 101,
      "name": "John Doe",
      "email": "[email protected]",
      "roleId": 1,
      "orgId": 101,
      "isDev": true
    }
  ],
  "totalElements": 1
}

Get user by ID

get

Retrieve detailed information about a specific user.

Required permissions, when user-scoped authentication is used: ORG_VIEW_USERS.

Authorizations

AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Query parameters

userIdinteger · int64Required

User ID

Responses

200

User details

application/json

400

Bad request

application/json

403

Forbidden

404

User not found or access denied

application/json

429

Too many requests

500

Internal server error

application/json

get

/api/v1/organization/user

GET /api/v1/organization/user?userId=1 HTTP/1.1
Host: blynk.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 101,
  "name": "John Doe",
  "email": "[email protected]",
  "roleId": 1,
  "orgId": 101,
  "isDev": true,
  "title": "Senior Engineer",
  "nickName": "Johnny",
  "phoneNumber": "+11234567890",
  "tz": "Europe/Kyiv",
  "locale": "en_US",
  "status": "Pending",
  "lastModifiedTs": 1707244800000,
  "lastLoggedAt": 1707244800000,
  "registeredAt": 1707244800000
}

Create a new user in personal organization

post

Create a personal organization and a new user in it.

If there is already an existing user with the provided email, API will return 200 OK response with the existing user details.

Required permissions, when user-scoped authentication is used: ORG_INVITE_USERS.

Authorizations

AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Body

emailstring · emailRequired

User email

Example: [email protected]

passwordstring · password · max: 200Required

User password

Example: mySecretPassword123

namestring · max: 50Optional

User's full name. Can only contain letters, hyphens, spaces, dots and apostrophes.

Example: John Doe

titlestring · max: 50Optional

User's title or position. Can only contain letters, hyphens and spaces.

Example: Sales Manager

nickNamestring · max: 50Optional

User's nickname. Can only contain letters, digits, hyphens and spaces.

Example: johnd

phoneNumberstringOptional

User's phone number

Example: +1234567890

organizationNamestring · min: 3 · max: 100Optional

Name of the personal organization to create. If not specified, the organization will be created with the default name. Can only contain letters, digits, spaces, dots, hyphens and apostrophes.

Example: John's Personal Org

tzstring · max: 200Optional

User's time zone

Example: America/New_York

Responses

200

User with the provided email already exists

application/json

201

User created successfully

application/json

400

Bad request

application/json

403

Forbidden

429

Too many requests

500

Internal server error

application/json

post

/api/v1/organization/users/create

POST /api/v1/organization/users/create HTTP/1.1
Host: blynk.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 354

{
  "email": "[email protected]",
  "password": "mySecretPassword123",
  "name": "John Doe",
  "title": "Sales Manager",
  "nickName": "johnd",
  "phoneNumber": "+1234567890",
  "organizationName": "John's Personal Org",
  "address": {
    "fullAddress": "1234 Apple St, Apt 5B, New York, NY 10001, USA",
    "country": "USA",
    "city": "New York",
    "state": "Texas",
    "zip": "10001"
  },
  "tz": "America/New_York"
}

{
  "id": 101,
  "name": "John Doe",
  "email": "[email protected]",
  "roleId": 1,
  "orgId": 101,
  "isDev": true,
  "title": "Senior Engineer",
  "nickName": "Johnny",
  "phoneNumber": "+11234567890",
  "tz": "Europe/Kyiv",
  "locale": "en_US",
  "status": "Pending",
  "lastModifiedTs": 1707244800000,
  "lastLoggedAt": 1707244800000,
  "registeredAt": 1707244800000
}

Create user in organization

post

Create a new user account in the existing organization.

The specified roleId must be a valid role in the target organization.

Required permissions, when user-scoped authentication is used: ORG_INVITE_USERS.

Authorizations

AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Body

emailstring · emailRequired

User email

Example: [email protected]

passwordstring · password · max: 200Required

User password

Example: mySecretPassword123

namestring · max: 50Optional

User's full name. Can only contain letters, hyphens, spaces, dots and apostrophes.

Example: John Doe

titlestring · max: 50Optional

User's title or position. Can only contain letters, hyphens and spaces.

Example: Sales Manager

nickNamestring · max: 50Optional

User's nickname. Can only contain letters, digits, hyphens and spaces.

Example: johnd

phoneNumberstringOptional

User's phone number

Example: +1234567890

tzstring · max: 200Optional

User's time zone

Example: America/New_York

orgIdinteger · int32Required

Organization ID to create user in.

Example: 101

roleIdinteger · int32Required

Role ID to assign to the user.

Example: 1

Responses

201

User created successfully

application/json

400

Bad request

application/json

403

Forbidden

404

Organization not found or access denied

application/json

429

Too many requests

500

Internal server error

application/json

post

/api/v1/organization/users/create-in-org

POST /api/v1/organization/users/create-in-org HTTP/1.1
Host: blynk.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 336

{
  "email": "[email protected]",
  "password": "mySecretPassword123",
  "name": "John Doe",
  "title": "Sales Manager",
  "nickName": "johnd",
  "phoneNumber": "+1234567890",
  "address": {
    "fullAddress": "1234 Apple St, Apt 5B, New York, NY 10001, USA",
    "country": "USA",
    "city": "New York",
    "state": "Texas",
    "zip": "10001"
  },
  "tz": "America/New_York",
  "orgId": 101,
  "roleId": 1
}

{
  "id": 101,
  "name": "John Doe",
  "email": "[email protected]",
  "roleId": 1,
  "orgId": 101,
  "isDev": true,
  "title": "Senior Engineer",
  "nickName": "Johnny",
  "phoneNumber": "+11234567890",
  "tz": "Europe/Kyiv",
  "locale": "en_US",
  "status": "Pending",
  "lastModifiedTs": 1707244800000,
  "lastLoggedAt": 1707244800000,
  "registeredAt": 1707244800000
}

Update user role

put

Update the role of a user in the organization.

When user-scoped authentication is used, the following validations apply:

The authenticated user cannot modify their own role
The authenticated user cannot assign a role with higher permissions than their own
The authenticated user cannot change the role of a user with higher permissions than their own

Required permissions, when user-scoped authentication is used: ORG_VIEW_USERS, ORG_EDIT_USERS.

Authorizations

AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Query parameters

userIdinteger · int64Required

User ID

roleIdinteger · int32Required

Role ID to assign

Responses

200

User role updated successfully

application/json

400

Bad request

application/json

403

Forbidden

404

User/role not found or access denied

application/json

429

Too many requests

500

Internal server error

application/json

put

/api/v1/organization/users/role

PUT /api/v1/organization/users/role?userId=1&roleId=1 HTTP/1.1
Host: blynk.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 101,
  "name": "John Doe",
  "email": "[email protected]",
  "roleId": 1,
  "orgId": 101,
  "isDev": true,
  "title": "Senior Engineer",
  "nickName": "Johnny",
  "phoneNumber": "+11234567890",
  "tz": "Europe/Kyiv",
  "locale": "en_US",
  "status": "Pending",
  "lastModifiedTs": 1707244800000,
  "lastLoggedAt": 1707244800000,
  "registeredAt": 1707244800000
}

Invite user to organization

post

Send an invitation to a user to join the organization.

Required permissions, when user-scoped authentication is used: ORG_INVITE_USERS.

Authorizations

AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Body

emailstring · emailRequiredExample: [email protected]

namestring · min: 1 · max: 100Required

User's full name. Cannot contain slashes, backslashes, < or >.

Example: John Doe

roleIdinteger · int32Required

Role ID to assign to the user upon accepting the invitation

Example: 1

orgIdinteger · int32Optional

Organization ID. If not provided, the organization associated with the authentication token will be used.

Example: 101

localestringOptional

User's locale

Example: en_US

Responses

201

Invitation sent successfully

application/json

400

Bad request

application/json

403

Forbidden

404

Organization not found or access denied

application/json

429

Too many requests

500

Internal server error

application/json

post

/api/v1/organization/users/invite

POST /api/v1/organization/users/invite HTTP/1.1
Host: blynk.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 86

{
  "email": "[email protected]",
  "name": "John Doe",
  "roleId": 1,
  "orgId": 101,
  "locale": "en_US"
}

{
  "id": 101,
  "name": "John Doe",
  "email": "[email protected]",
  "roleId": 1,
  "orgId": 101,
  "isDev": true,
  "title": "Senior Engineer",
  "nickName": "Johnny",
  "phoneNumber": "+11234567890",
  "tz": "Europe/Kyiv",
  "locale": "en_US",
  "status": "Pending",
  "lastModifiedTs": 1707244800000,
  "lastLoggedAt": 1707244800000,
  "registeredAt": 1707244800000
}

Register user

post

Create a new personal organization and send user invitation for registration.

User-scoped authentication is not allowed for this endpoint.

Authorizations

AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Body

emailstring · emailRequired

User email

Example: [email protected]

localestringOptional

User's locale

Example: en_US

Responses

201

User registered successfully

application/json

400

Bad request

application/json

403

Forbidden

429

Too many requests

500

Internal server error

application/json

post

/api/v1/organization/users/register

POST /api/v1/organization/users/register HTTP/1.1
Host: blynk.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "email": "[email protected]",
  "locale": "en_US"
}

{
  "id": 101,
  "name": "John Doe",
  "email": "[email protected]",
  "roleId": 1,
  "orgId": 101,
  "isDev": true,
  "title": "Senior Engineer",
  "nickName": "Johnny",
  "phoneNumber": "+11234567890",
  "tz": "Europe/Kyiv",
  "locale": "en_US",
  "status": "Pending",
  "lastModifiedTs": 1707244800000,
  "lastLoggedAt": 1707244800000,
  "registeredAt": 1707244800000
}

Transfer user to another organization

post

Transfer a user to a different organization.

The following constraints apply:

Users in Pending status cannot be transferred
Cannot transfer a user to the same organization they are already in
The destination organization must not exceed its user limit

Required permissions, when user-scoped authentication is used: ORG_VIEW_USERS, TRANSFER_USER.

Authorizations

AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Body

userIdinteger · int64Required

User ID

Example: 101

targetOrgIdinteger · int32Required

Target organization ID

Example: 101

roleIdinteger · int32 · min: 1Required

Role ID to assign to the user in the target organization

Example: 1

Responses

200

User transferred successfully

application/json

400

Bad request

application/json

403

Forbidden or no access to user's/target organization

application/json

404

User or organization not found

application/json

429

Too many requests

500

Internal server error

application/json

post

/api/v1/organization/users/transfer

POST /api/v1/organization/users/transfer HTTP/1.1
Host: blynk.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "userId": 101,
  "targetOrgId": 101,
  "roleId": 1
}

{
  "id": 101,
  "name": "John Doe",
  "email": "[email protected]",
  "roleId": 1,
  "orgId": 101,
  "isDev": true,
  "title": "Senior Engineer",
  "nickName": "Johnny",
  "phoneNumber": "+11234567890",
  "tz": "Europe/Kyiv",
  "locale": "en_US",
  "status": "Pending",
  "lastModifiedTs": 1707244800000,
  "lastLoggedAt": 1707244800000,
  "registeredAt": 1707244800000
}

Send push notification to user

post

Send a push notification to a user's mobile devices.

This endpoint is available only when organization-scoped authentication is used.

Authorizations

AuthorizationstringRequired

OAuth2 Bearer token obtained from authentication endpoint

Body

userIdinteger · int64Required

User ID

Example: 101

titlestring · max: 50Required

Notification title

Example: Device Alert

bodystring · max: 255Optional

Notification message body

Example: Your device temperature is too high!

imageUrlstring · max: 1024Optional

URL of the image to display in the notification (optional)

Example: https://example.com/alert.png

Responses

204

Push notification sent successfully

400

Bad request

application/json

403

Forbidden

application/json

404

User not found or access denied

application/json

429

Too many requests

500

Internal server error

application/json

post

/api/v1/organization/users/send-push-notification

POST /api/v1/organization/users/send-push-notification HTTP/1.1
Host: blynk.cloud
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 126

{
  "userId": 101,
  "title": "Device Alert",
  "body": "Your device temperature is too high!",
  "imageUrl": "https://example.com/alert.png"
}

No content

PreviousStatic Tokens NextTemplates

Last updated 1 day ago

Was this helpful?

hashtagGet user profile

hashtagGet users in organization

hashtagSearch users

hashtagGet user by ID

hashtagCreate a new user in personal organization

hashtagCreate user in organization

hashtagUpdate user role

hashtagInvite user to organization

hashtagRegister user

hashtagTransfer user to another organization

hashtagSend push notification to user

Get user profile

Get users in organization

Search users

Get user by ID

Create a new user in personal organization

Create user in organization

Update user role

Invite user to organization

Register user

Transfer user to another organization

Send push notification to user