search-filters
Models
Activity
ActivityType
BillingURLs
Company
Contact
Country
CreateDraft
CreatePipelineRequest
Currency
CustomField
CustomFieldValue
CustomFilter
CustomFilterColumn
CustomFilterCondition
Deal
DealPagedReportMeta
DealProjectsData
DealReportData
DealReportStatus
DealReportStatuses
DealReportWithIncludes
EmailAccount
EmailFile
EmailMailbox
EmailMessage
EmailParticipant
EmailProvider
EmailProviderSettings
EmailThread
EntityPosition
Event
Export
FeatureAnnouncement
File
FileThumbnail
FileUploadRequest
FileUploadRequestFile
ForecastUnit
ForeignItemLink
ForeignItemLinkCounts
ImportHistory
ImportsListResponse
Included
InstallationSettings
ListResponseMeta
LostReason
Note
OvertimePoint
OvertimeReportData
OvertimeReportDataMeta
OvertimeReportWithIncludes
Page
PatchPipelineRequest
PhoneCode
Pipeline
PipelineResponse
PipelinesResponse
Product
ReportPage
ResourceIdentifier
ResourceIdentifierRequest
ResponseMeta
SearchableEntity
Stage
Timezone
User
Webhook
WebhookEvent
WebhookRequest
WonReason
activitiesListResponse
activitiesResponse
activityPositionResponse
activityResponse
activityTypeResponse
activityTypesResponse
bulkUpdateActivityRequestWithOptions
bulkUpdateCompanyRequestWithOptions
bulkUpdateContactRequestWithOptions
bulkUpdateDealRequestWithOptions
bulkUpdateProductRequestWithOptions
bulkUpdateResponse
bulkUpdateRetryRequest
bulkUpdateUserRequestWithOptions
companiesListResponse
companiesResponse
companyPositionResponse
companyResponse
completeInviteRequest
connectEmailRequest
contactPositionResponse
contactResponse
contactsListResponse
contactsResponse
countriesResponse
countryResponse
createActivityRequest
createActivityTypeRequest
createCompanyRequest
createContactRequest
createCustomFieldRequest
createCustomFilterRequest
createDealMeta
createDealRequest
createDraftRequest
createExportRequest
createLostReason
createLostReasonRequest
createNote
createNoteRequest
createProductRequest
createStageRequest
createWebhookRequest
createWonReason
createWonReasonRequest
createdFilesResponse
currenciesResponse
currencyResponse
customFieldResponse
customFieldsResponse
customFilterColumnRequest
customFilterConditionRequest
customFilterResponse
customFiltersResponse
dealListMeta
dealPositionResponse
dealResponse
dealsListResponse
dealsResponse
deleteEmailThreadsRequest
disconnectDealForeignLinksRequest
docErrorResp
duplicateContactRequest
emailAccountResponse
emailAccountsResponse
emailMessageResponse
emailProvidersResponse
emailThreadResponse
eventsResponse
exportResponse
exportsResponse
featureAnnouncementsResponse
feedbackRequest
fileResponse
filesResponse
forecastResponse
healthResponse
installationSettingsResponse
inviteRequest
lostReasonResponse
lostReasonsResponse
mailboxResponse
mailboxesResponse
meResponse
messagesResponse
noteResponse
patchActivityRequest
patchActivityTypeRequest
patchCompanyRequest
patchContactRequest
patchCustomFieldRequest
patchCustomFilterRequest
patchDealRequest
patchEmailAccount
patchEmailAccountRequest
patchEmailMessageRequest
patchEmailThreadRequest
patchEmailThreadsRequest
patchFileRequest
patchInstallationSettingsRequest
patchLostReason
patchLostReasonRequest
patchMailboxRequest
patchNote
patchNoteRequest
patchProductRequest
patchStageRequest
patchUserRequest
patchWebhookRequest
patchWonReason
patchWonReasonRequest
phoneCodesResponse
pipelineBoardMetaResponse
pipelineBoardResponse
productResponse
productsListResponse
productsResponse
searchableResponse
sessionResponse
stageGetMeta
stageResponse
stagesResponse
subscriptionURLSResponse
threadsResponse
timezoneResponse
timezonesResponse
unreadCountResponse
uploadEmailFileRequest
uploadEmailFileResponse
userPositionResponse
userResponse
userState
userStateResponse
usersListResponse
usersResponse
webhookEventsMeta
webhookEventsResponse
webhookRequestResponse
webhookRequestsResponse
webhookResponse
webhooksResponse
wonReasonResponse
wonReasonsResponse
Powered by Stoplight

User

User represents a user in the CRM system.

object
activatedAt
string

Date the user was first marked as active.

1 validation
avatar
object

Resource identifier object which describes a relationship to another entity.

createdAt
string

When the item was created, as a datetime

1 validation
createdBy
object

Resource identifier object linking the user who created the entity.

dateFormatId

Identifier of the date format. Currently supported date formats are and will be displayed for the give date of 2nd of January 2006 as:

  • 1: “dd/mm/yyyy” will be displayed as “02/01/2006”.
  • 2: “mm/dd/yyyy” will be displayed as “01/02/2006”.
  • 3: “dd.mm.yyyy” will be displayed as “02.01.2006”.
  • 4: “yyyy-mm-dd” will be displayed as “2006-01-02”.
  • 5: “yyyy.mm.dd” will be displayed as “2006.01.02”.
  • 6: “mm.dd.yyyy” will be displayed as “01.02.2006”.
1 validation
deletedAt
string

When the item was deleted, as a datetime

1 validation
deletedBy
object

Resource identifier object linking the user who deleted the entity.

emailAddresses
array[object]
firstName
string
id
integer
isAdmin
boolean

Is the user a CRM admin.

isGlobalAdmin
boolean

Is the user a global admin across products.

isProjectsContact
boolean

Is the user of type contact.

lastName
string
phoneNumbers
array[object]
state
string

State of the user.

1 validation
timeFormatId

Identifier of the time format. Currently supported time formats are and will be displayed for the give time of 15 hours 4 minutes as:

  • 1: “h:mmtt” will be displayed as “3:04pm”.
  • 2: “HH:MM” will be displayed as “15:04”.
1 validation
timezone
object

Resource identifier object which describes a relationship to another entity.

title
string
updatedAt
string

When the item was last updated, as a datetime

1 validation
updatedBy
object

Resource identifier object linking the user who last updated the entity.

updatedSourceId
integer

Source ID of the latest request made (API / Web app)

1 validation
weekStartsSunday
boolean

Does the user’s week start on Sunday as opposed to the default of Monday