Asset Management API

Site Partner Users

post/asset-management/v1/site-partner-users/{sitePartnerUserId}/archive

Archive a site partner user by ID.

Archives a site partner user by ID if it exists and if the user is associated with the current network. This will set isArchived field to true.
This action is not enabled by default. You must request additional permissions to perform this action.

sitePartnerUserIdstring

required

The ID of the site partner user to be archived

Responses

Response examples

Site partner user deleted successfully.

Empty response

get/asset-management/v1/site-partner-users

List all site partner users

This endpoint retrieves a list of all Site Partner Users

limitstring

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

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

startingAfterstring

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

Responses

Response examples

A list of site partner users

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

post/asset-management/v1/site-partner-users

Create a new site partner user

This endpoint creates a new site partner user
This action is not enabled by default. You must request additional permissions to perform this action.

emailstring or null

required

If the email is null that means tha site partner user has been archived

partnerstring

required

The ID of the partner associated with the user

firstNamestring

The first name of the site partner user

lastNamestring

The last name of the site partner user

Responses

Request examples

{
  "email": "string",
  "partner": "string",
  "firstName": "string",
  "lastName": "string"
}

Response examples

Success

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

patch/asset-management/v1/site-partner-users/{sitePartnerUserId}

Update a site partner user

This endpoint updates an existing site partner user by its ID.
This action is not enabled by default. You must request additional permissions to perform this action.

emailstring

The email of the site partner user

firstNamestring

The first name of the site partner user

lastNamestring

The last name of the site partner user

Responses

Request examples

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

Response examples

Success. Returns the updated site partner user.

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

Was this page helpful?