Get User

GET 
/crm/users/:userId

Get user based on id

Request

Path Parameters

userId stringrequired

The item id of the user record

Query Parameters

credentialId stringrequired

The ID of the credential.

Header Parameters

Authorization stringrequired

Default value: bearer YOUR_API_KEY

Responses

200

200

application/json

Schema

Schema

user

object

id string

remoteId string

userFirstName string

userLastName string

userEmail string

isActive

remoteCreatedAt string

remoteUpdatedAt string

remoteDeleted boolean

Default value: true

createdAt string

updatedAt string

Example (from schema)

{
  "user": {
    "id": "00000000-0000-0000-0000-000000000000",
    "remoteId": "5969180000000474001",
    "userFirstName": "Jon",
    "userLastName": "jacob",
    "userEmail": "jon@runalloy.com",
    "isActive": {},
    "remoteCreatedAt": "2023-11-19T17:00:17.000Z",
    "remoteUpdatedAt": "2023-11-19T17:00:17.000Z",
    "remoteDeleted": false,
    "createdAt": "2024-02-22T11:17:53.264Z",
    "updatedAt": "2024-02-22T13:54:03.445Z"
  }
}

Result

{
  "user": {
    "id": "00000000-0000-0000-0000-000000000000",
    "remoteId": "5969180000000474001",
    "userFirstName": "Jon",
    "userLastName": "jacob",
    "userEmail": "jon@runalloy.com",
    "isActive": null,
    "remoteCreatedAt": "2023-11-19T17:00:17.000Z",
    "remoteUpdatedAt": "2023-11-19T17:00:17.000Z",
    "remoteDeleted": false,
    "createdAt": "2024-02-22T11:17:53.264Z",
    "updatedAt": "2024-02-22T13:54:03.445Z"
  }
}

400

400

application/json

Schema

Schema

object

Example (from schema)

{}

Result

{}

Loading...