Asset Management API

Network Users

Download Spec

get/asset-management/v1/network-users

List all network users

This endpoint retrieves a list of all Network Users

limitstring

The maximum number of network users to return (default 20, maximum 100)

Pattern: ^[0-9][0-9]?$|^100$

startingAfterstring

The ID of the last network user in the previous page of results. Results will start after this network user

Responses

Response examples

A list of network users

{
  "data": {
    "hasMore": true,
    "items": [
      {
        "id": "string",
        "email": "string",
        "network": {
          "id": "string"
        },
        "firstName": "string",
        "lastName": "string",
        "isArchived": true,
        "phoneNumber": "string",
        "createdAt": "2023-06-07T17:32:28Z",
        "updatedAt": "2023-06-07T17:32:28Z"
      }
    ]
  }
}

post/asset-management/v1/network-users

Create a new network user

This endpoint creates a new network user (network operator/admin).
This action is not enabled by default. You must request additional permissions to perform this action.

emailstring

required

The email of the network user

firstNamestring

required

The first name of the network user

lastNamestring

required

The last name of the network user

networkstring

required

The ID of the network the user belongs to

phoneNumberstring or null

Optional phone number in "+11231231234" format

Responses

Request examples

{
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "network": "string",
  "phoneNumber": "string"
}

Response examples

Success

{
  "data": {
    "id": "string",
    "email": "string",
    "network": {
      "id": "string"
    },
    "firstName": "string",
    "lastName": "string",
    "isArchived": true,
    "phoneNumber": "string",
    "createdAt": "2023-06-07T17:32:28Z",
    "updatedAt": "2023-06-07T17:32:28Z"
  }
}

get/asset-management/v1/network-users/{networkUserId}

Retrieve a network user by ID

Retrieves a network user by ID if it exists and is associated with the current network.

networkUserIdstring

required

The ID of the network user to retrieve

Responses

Response examples

Success

{
  "data": {
    "id": "string",
    "email": "string",
    "network": {
      "id": "string"
    },
    "firstName": "string",
    "lastName": "string",
    "isArchived": true,
    "phoneNumber": "string",
    "createdAt": "2023-06-07T17:32:28Z",
    "updatedAt": "2023-06-07T17:32:28Z"
  }
}

delete/asset-management/v1/network-users/{networkUserId}

Delete a network user by ID

Deletes (archives) a network user by ID if it exists and is associated with the current network. The row is retained with isArchived=true, its PII fields are nullified, and the user's PII is crypto-shredded in the PII vault (GDPR Art. 17). Archived users are hidden from GET and list.
This action is not enabled by default. You must request additional permissions to perform this action.

networkUserIdstring

required

The ID of the network user to delete

Responses

Response examples

Network user deleted successfully.

Empty response

patch/asset-management/v1/network-users/{networkUserId}

Update a network user

This endpoint updates an existing network user by its ID. Only firstName, lastName, and phoneNumber may be updated; email and network are immutable.
This action is not enabled by default. You must request additional permissions to perform this action.

firstNamestring

The first name of the network user

lastNamestring

The last name of the network user

phoneNumberstring or null

Optional phone number in "+11231231234" format

Responses

Request examples

{
  "firstName": "string",
  "lastName": "string",
  "phoneNumber": "string"
}

Response examples

Success. Returns the updated network user.

{
  "data": {
    "id": "string",
    "email": "string",
    "network": {
      "id": "string"
    },
    "firstName": "string",
    "lastName": "string",
    "isArchived": true,
    "phoneNumber": "string",
    "createdAt": "2023-06-07T17:32:28Z",
    "updatedAt": "2023-06-07T17:32:28Z"
  }
}

Was this page helpful?