GEgetmaintainx
Users

Create new user

Changed on
post/users

Request

  • Base URL
    https://api.getmaintainx.com/v1
  • Auth
    HTTP bearer

Query parameters

skipWebhookboolean

Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks

Headers

x-organization-idinteger

Required if using a multi organizations token

Request body

firstNamestring required
lastNamestring required
role'ADMIN' | 'MEMBER' | 'OPERATOR' | 'VIEW_ONLY' | 'REQUESTER' | 'SERVICE_ACCOUNT' nullable
customRolestring nullable

Custom role name if the user has a custom role assigned

emailstring nullable
phoneNumberstring nullable
extraFieldsobject

Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: "Department")

authType'NORMAL' | 'SAML' | 'OIDC' nullable
inviteType'ALL' | 'EMAIL' | 'SMS' | 'NONE' nullable
hourlyRateinteger nullable

Cost in cents. For example, for $1.20, put 120. Set to null to set the user's rate to organization default hourly rate if defined, otherwise it would set the rate to the user's hourly rate defined in any work order. If none is defined, setting null will set the user's hourly rate to null

Example request

{
  "firstName": "John",
  "lastName": "Doe",
  "role": "MEMBER",
  "customRole": "Custom Role Name",
  "email": "user@example.com",
  "phoneNumber": "415-555-0100",
  "externalData": {
    "popularErpSolutionId": "asd732da"
  },
  "extraFields": {
    "Department": "Engineering"
  },
  "authType": "SAML",
  "inviteType": "ALL",
  "hourlyRate": 120
}

Response

Successfully created user

idinteger required

Global ID of the user

Example response

{
  "id": 963
}

Changes

  • 2b88e9e9811fRevision changes
    • info

      added the new VIEW_ONLY enum value to the request property

  • 222e6fad7c1fRevision changes
    • breaking

      removed the media type application/octet-stream from the request body

    • info

      added the new optional header request parameter x-organization-id

    • info

      added the new optional query request parameter skipWebhook

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new OPERATOR enum value to the request property

    • info

      added the new SERVICE_ACCOUNT enum value to the request property

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status