List Users

GET 
/crm/users

List users based on a given criteria

Request

Query Parameters

credentialId stringrequired

The ID of the credential.

pageNumber string

The page number of the results. Default is 1.

pageSize int32

The maximum number of results to show on a page. Default is 50. Maximum is 100.

userFirstName string

Filter users by their exact first name.

userFirstNameContains string

Filter users where the first name contains the specified string.

userFirstNameNotEquals string

Filter users where the first name is not the specified string.

userLastName string

Filter users by their exact last name.

userLastNameContains string

Filter users where the last name contains the specified string.

userLastNameNotEquals string

Filter users where the last name is not the specified string.

userEmail string

Filter users by their exact email address.

userEmailContains string

Filter users where the email address contains the specified string.

userEmailNotEquals string

Filter users where the email address is not the specified string.

isActive boolean

Filter users based on whether they are active (true) or not (false).

isActiveNotEquals boolean

Filter users where the active status is not the specified boolean value.

remoteCreatedAtMin date

Filter objects created in the third-party application after a specified date.

remoteCreatedAtMax date

Filter objects created in the third-party application before a specified date.

remoteUpdatedAtMin date

Filter objects last updated in the third-party application after a specified date.

remoteUpdatedAtMax date

Filter objects last updated in the third-party application before a specified date.

createdAtMin date

Filter objects created after a specified date.

createdAtMax date

Filter objects created before a specified date.

updatedAtMin date

Filter objects last updated after a specified date.

updatedAtMax date

Filter objects last updated before a specified date.

Header Parameters

Authorization stringrequired

Default value: bearer YOUR_API_KEY

Responses

200

200

application/json

Schema

Schema

users

object[]

Array [

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)

{
  "users": [
    {
      "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

{
  "users": [
    {
      "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...