OBJECT
Contact

A contact person.
GraphQL Schema definition

type Contact implements SearchableInterface, EmailableInterface, SmsableInterface, CustomfielddataableInterface, NoteableInterface, LoggableInterface, AccessloggableInterface {
#   The ID of the entity.
id: Int64Bit! 
#   An ID that uniquely identifies this entity across the whole Sonar system.
sonar_unique_id: ID! 
#   The date and time this entity was created.
created_at: Datetime! 
#   The last date and time this entity was modified.
updated_at: Datetime! 
#   A string that shows the version of this entity. It will be incremented whenever 
#   the entity is modified.
_version: String! 
#   The ID of the entity that owns this contact.
contactable_id: Int64Bit! 
#   The type of entity that owns this contact.
contactable_type: ContactableType! 
#   An email address.
email_address: EmailAddress 
#   A supported language.
language: Language 
#   Whether or not marketing messages accepted.
marketing_opt_in: Boolean 
#   A descriptive name.
name: String! 
#   Whether or not this is the primary type of entity.
primary: Boolean! 
#   The role of the contact, e.g. "CEO" or "Network Engineer".
role: String 
#   A username, used for authentication.
username: String 
#   The owner of this `Contact`.
# 
# Arguments
#   id: The ID of the entity.
#   sonar_unique_id: An ID that uniquely identifies this entity 
#   across the whole Sonar system.
#   created_at: The date and time this entity was created.
#   updated_at: The last date and time this entity was modified.
#   paginator: Provides the ability to paginate through results.
#   sorter: Provides the ability to sort results.
#   search: Complex search parameters.
#   general_search: Search across all string fields with partial 
#   matching.
#   include_archived: Whether or not to include archived entities 
#   in the results.
contactable(
id: Int64Bit,
sonar_unique_id: ID,
created_at: Datetime,
updated_at: Datetime,
paginator: Paginator,
sorter: [Sorter],
search: [Search],
general_search: String,
include_archived: Boolean
): ContactableInterface 
#   A phone number.
# 
# Arguments
#   id: The ID of the entity.
#   sonar_unique_id: An ID that uniquely identifies this entity 
#   across the whole Sonar system.
#   created_at: The date and time this entity was created.
#   updated_at: The last date and time this entity was modified.
#   _version: A string that shows the version of this entity. It 
#   will be incremented whenever the entity is modified.
#   contact_id: The ID of the contact that owns this.
#   country: A two character country code for this phone number.
#   extension: The extension.
#   number: The number.
#   number_formatted: A phone number formatted for human 
#   readability.
#   phone_number_type_id: The ID of the PhoneNumberType associated 
#   with this phone number.
#   sms_opt_in: Whether or not SMS messages accepted.
#   paginator: Provides the ability to paginate through results.
#   sorter: Provides the ability to sort results.
#   search: Complex search parameters.
#   general_search: Search across all string fields with partial 
#   matching.
#   aggregation: Provides the ability to return aggregated 
#   mathematical data about your results.
#   reverse_relation_filters: Reverse relation filters allow you to 
#   filter the result of a relation, and use that filter to affect the returned root 
#   elements.
phone_numbers(
id: Int64Bit,
sonar_unique_id: ID,
created_at: Datetime,
updated_at: Datetime,
_version: String,
contact_id: Int64Bit,
country: Country,
extension: Numeric,
number: Numeric,
number_formatted: String,
phone_number_type_id: Int64Bit,
sms_opt_in: Boolean,
paginator: Paginator,
sorter: [Sorter],
search: [Search],
general_search: String,
aggregation: [Aggregator],
reverse_relation_filters: [ReverseRelationFilter]
): PhoneNumberConnection! 
#   A contract.
# 
# Arguments
#   id: The ID of the entity.
#   sonar_unique_id: An ID that uniquely identifies this entity 
#   across the whole Sonar system.
#   created_at: The date and time this entity was created.
#   updated_at: The last date and time this entity was modified.
#   _version: A string that shows the version of this entity. It 
#   will be incremented whenever the entity is modified.
#   account_id: The ID of an Account.
#   body: The body.
#   contact_id: The ID of the contact that owns this.
#   contract_template_id: The ID of a `ContractTemplate`.
#   custom_message: The custom message.
#   expiration_date: The expiration date.
#   handwritten_signature_id: The ID of a `HandwrittenSignature`.
#   name: A descriptive name.
#   term_in_months: The term in months.
#   unique_link_key: Part of the unique URL used for signing.
#   paginator: Provides the ability to paginate through results.
#   sorter: Provides the ability to sort results.
#   search: Complex search parameters.
#   general_search: Search across all string fields with partial 
#   matching.
#   aggregation: Provides the ability to return aggregated 
#   mathematical data about your results.
#   reverse_relation_filters: Reverse relation filters allow you to 
#   filter the result of a relation, and use that filter to affect the returned root 
#   elements.
contracts(
id: Int64Bit,
sonar_unique_id: ID,
created_at: Datetime,
updated_at: Datetime,
_version: String,
account_id: Int64Bit,
body: Text,
contact_id: Int64Bit,
contract_template_id: Int64Bit,
custom_message: Text,
expiration_date: Date,
handwritten_signature_id: Int64Bit,
name: String,
term_in_months: Int,
unique_link_key: String,
paginator: Paginator,
sorter: [Sorter],
search: [Search],
general_search: String,
aggregation: [Aggregator],
reverse_relation_filters: [ReverseRelationFilter]
): ContractConnection! 
#   A categorization of a message by type.
# 
# Arguments
#   id: The ID of the entity.
#   sonar_unique_id: An ID that uniquely identifies this entity 
#   across the whole Sonar system.
#   created_at: The date and time this entity was created.
#   updated_at: The last date and time this entity was modified.
#   _version: A string that shows the version of this entity. It 
#   will be incremented whenever the entity is modified.
#   default: Whether or not this entity is a default entry.
#   name: A descriptive name.
#   paginator: Provides the ability to paginate through results.
#   sorter: Provides the ability to sort results.
#   search: Complex search parameters.
#   general_search: Search across all string fields with partial 
#   matching.
#   aggregation: Provides the ability to return aggregated 
#   mathematical data about your results.
#   reverse_relation_filters: Reverse relation filters allow you to 
#   filter the result of a relation, and use that filter to affect the returned root 
#   elements.
message_categories(
id: Int64Bit,
sonar_unique_id: ID,
created_at: Datetime,
updated_at: Datetime,
_version: String,
default: Boolean,
name: String,
paginator: Paginator,
sorter: [Sorter],
search: [Search],
general_search: String,
aggregation: [Aggregator],
reverse_relation_filters: [ReverseRelationFilter]
): MessageCategoryConnection! 
#   A categorization of an `Email` by type.
# 
# Arguments
#   id: The ID of the entity.
#   sonar_unique_id: An ID that uniquely identifies this entity 
#   across the whole Sonar system.
#   created_at: The date and time this entity was created.
#   updated_at: The last date and time this entity was modified.
#   _version: A string that shows the version of this entity. It 
#   will be incremented whenever the entity is modified.
#   default: Whether or not this entity is a default entry.
#   name: A descriptive name.
#   paginator: Provides the ability to paginate through results.
#   sorter: Provides the ability to sort results.
#   search: Complex search parameters.
#   general_search: Search across all string fields with partial 
#   matching.
#   aggregation: Provides the ability to return aggregated 
#   mathematical data about your results.
#   reverse_relation_filters: Reverse relation filters allow you to 
#   filter the result of a relation, and use that filter to affect the returned root 
#   elements.
email_categories(
id: Int64Bit,
sonar_unique_id: ID,
created_at: Datetime,
updated_at: Datetime,
_version: String,
default: Boolean,
name: String,
paginator: Paginator,
sorter: [Sorter],
search: [Search],
general_search: String,
aggregation: [Aggregator],
reverse_relation_filters: [ReverseRelationFilter]
): EmailCategoryConnection! 
#   A mass email communication.
# 
# Arguments
#   id: The ID of the entity.
#   sonar_unique_id: An ID that uniquely identifies this entity 
#   across the whole Sonar system.
#   created_at: The date and time this entity was created.
#   updated_at: The last date and time this entity was modified.
#   _version: A string that shows the version of this entity. It 
#   will be incremented whenever the entity is modified.
#   from_email_address: The email address to send from when using 
#   this email message. If `null`, then the system default will be used.
#   from_name: The name to send from when using this email message. 
#   If `null`, then the system default will be used.
#   inbox_preview: A short sentence that will be shown as a preview 
#   in compatible email clients.
#   message: The message.
#   subject: The subject.
#   user_id: The ID of a User.
#   paginator: Provides the ability to paginate through results.
#   sorter: Provides the ability to sort results.
#   search: Complex search parameters.
#   general_search: Search across all string fields with partial 
#   matching.
#   aggregation: Provides the ability to return aggregated 
#   mathematical data about your results.
#   reverse_relation_filters: Reverse relation filters allow you to 
#   filter the result of a relation, and use that filter to affect the returned root 
#   elements.
mass_emails(
id: Int64Bit,
sonar_unique_id: ID,
created_at: Datetime,
updated_at: Datetime,
_version: String,
from_email_address: EmailAddress,
from_name: String,
inbox_preview: String,
message: Text,
subject: String,
user_id: Int64Bit,
paginator: Paginator,
sorter: [Sorter],
search: [Search],
general_search: String,
aggregation: [Aggregator],
reverse_relation_filters: [ReverseRelationFilter]
): MassEmailConnection! 
#   An email.
# 
# Arguments
#   id: The ID of the entity.
#   sonar_unique_id: An ID that uniquely identifies this entity 
#   across the whole Sonar system.
#   created_at: The date and time this entity was created.
#   updated_at: The last date and time this entity was modified.
#   _version: A string that shows the version of this entity. It 
#   will be incremented whenever the entity is modified.
#   body: The body.
#   email_address: An email address.
#   emailable_id: The ID of the entity that this email was sent to.
#   emailable_type: The type of entity that this email was sent to.
#   reject_reason: If rejected, the reason for rejection.
#   status: The status.
#   subject: The subject.
#   to_name: The name of the recipient.
#   paginator: Provides the ability to paginate through results.
#   sorter: Provides the ability to sort results.
#   search: Complex search parameters.
#   general_search: Search across all string fields with partial 
#   matching.
#   aggregation: Provides the ability to return aggregated 
#   mathematical data about your results.
#   reverse_relation_filters: Reverse relation filters allow you to 
#   filter the result of a relation, and use that filter to affect the returned root 
#   elements.
emails(
id: Int64Bit,
sonar_unique_id: ID,
created_at: Datetime,
updated_at: Datetime,
_version: String,
body: Text,
email_address: EmailAddress,
emailable_id: Int64Bit,
emailable_type: EmailableType,
reject_reason: String,
status: EmailStatus,
subject: String,
to_name: String,
paginator: Paginator,
sorter: [Sorter],
search: [Search],
general_search: String,
aggregation: [Aggregator],
reverse_relation_filters: [ReverseRelationFilter]
): EmailConnection! 
#   An SMS outbound message.
# 
# Arguments
#   id: The ID of the entity.
#   sonar_unique_id: An ID that uniquely identifies this entity 
#   across the whole Sonar system.
#   created_at: The date and time this entity was created.
#   updated_at: The last date and time this entity was modified.
#   _version: A string that shows the version of this entity. It 
#   will be incremented whenever the entity is modified.
#   category: The category of the message.
#   cost_in_hundredths: The cost associated with the SMS message. 
#   Stored as one hundredth of the smallest currency value (e.g. cents, pence, 
#   pesos.)
#   destination_country: The country code of the destination mobile 
#   phone number.
#   error_message: The error message.
#   last_status_check: The provider message ID.
#   message_text: The message text.
#   mobile_number: The destination mobile phone number.
#   provider_message_id: The provider message ID.
#   segments: The number of segments needed to deliver message 
#   text.
#   smsable_id: The ID of the entity that this SMS was sent to.
#   smsable_type: The type of entity that this SMS was sent to.
#   status: The current status of the message.
#   paginator: Provides the ability to paginate through results.
#   sorter: Provides the ability to sort results.
#   search: Complex search parameters.
#   general_search: Search across all string fields with partial 
#   matching.
#   aggregation: Provides the ability to return aggregated 
#   mathematical data about your results.
#   reverse_relation_filters: Reverse relation filters allow you to 
#   filter the result of a relation, and use that filter to affect the returned root 
#   elements.
sms_outbound_messages(
id: Int64Bit,
sonar_unique_id: ID,
created_at: Datetime,
updated_at: Datetime,
_version: String,
category: SmsOutboundCategory,
cost_in_hundredths: Int,
destination_country: String,
error_message: String,
last_status_check: Datetime,
message_text: String,
mobile_number: String,
provider_message_id: String,
segments: Int,
smsable_id: Int64Bit,
smsable_type: SmsableType,
status: SmsOutboundStatus,
paginator: Paginator,
sorter: [Sorter],
search: [Search],
general_search: String,
aggregation: [Aggregator],
reverse_relation_filters: [ReverseRelationFilter]
): SmsOutboundMessageConnection! 
#   Data entered into a `CustomField`.
# 
# Arguments
#   id: The ID of the entity.
#   sonar_unique_id: An ID that uniquely identifies this entity 
#   across the whole Sonar system.
#   created_at: The date and time this entity was created.
#   updated_at: The last date and time this entity was modified.
#   _version: A string that shows the version of this entity. It 
#   will be incremented whenever the entity is modified.
#   custom_field_id: The ID of a CustomField that is associated 
#   with this type of entity.
#   customfielddataable_id: The ID of the entity that owns this 
#   custom field data.
#   customfielddataable_type: The type of entity that owns this 
#   custom field data.
#   value: The value.
#   paginator: Provides the ability to paginate through results.
#   sorter: Provides the ability to sort results.
#   search: Complex search parameters.
#   general_search: Search across all string fields with partial 
#   matching.
#   aggregation: Provides the ability to return aggregated 
#   mathematical data about your results.
#   reverse_relation_filters: Reverse relation filters allow you to 
#   filter the result of a relation, and use that filter to affect the returned root 
#   elements.
custom_field_data(
id: Int64Bit,
sonar_unique_id: ID,
created_at: Datetime,
updated_at: Datetime,
_version: String,
custom_field_id: Int64Bit,
customfielddataable_id: Int64Bit,
customfielddataable_type: CustomfielddataableType,
value: String,
paginator: Paginator,
sorter: [Sorter],
search: [Search],
general_search: String,
aggregation: [Aggregator],
reverse_relation_filters: [ReverseRelationFilter]
): CustomFieldDataConnection! 
#   A note.
# 
# Arguments
#   id: The ID of the entity.
#   sonar_unique_id: An ID that uniquely identifies this entity 
#   across the whole Sonar system.
#   created_at: The date and time this entity was created.
#   updated_at: The last date and time this entity was modified.
#   _version: A string that shows the version of this entity. It 
#   will be incremented whenever the entity is modified.
#   message: The message.
#   noteable_id: The ID of the entity that owns this note.
#   noteable_type: The type of entity that owns this note.
#   priority: The priority of this item.
#   user_id: The ID of a User.
#   paginator: Provides the ability to paginate through results.
#   sorter: Provides the ability to sort results.
#   search: Complex search parameters.
#   general_search: Search across all string fields with partial 
#   matching.
#   aggregation: Provides the ability to return aggregated 
#   mathematical data about your results.
#   reverse_relation_filters: Reverse relation filters allow you to 
#   filter the result of a relation, and use that filter to affect the returned root 
#   elements.
notes(
id: Int64Bit,
sonar_unique_id: ID,
created_at: Datetime,
updated_at: Datetime,
_version: String,
message: Text,
noteable_id: Int64Bit,
noteable_type: NoteableType,
priority: NotePriority,
user_id: Int64Bit,
paginator: Paginator,
sorter: [Sorter],
search: [Search],
general_search: String,
aggregation: [Aggregator],
reverse_relation_filters: [ReverseRelationFilter]
): NoteConnection! 
#   A log entry.
# 
# Arguments
#   id: The ID of the entity.
#   sonar_unique_id: An ID that uniquely identifies this entity 
#   across the whole Sonar system.
#   created_at: The date and time this entity was created.
#   updated_at: The last date and time this entity was modified.
#   _version: A string that shows the version of this entity. It 
#   will be incremented whenever the entity is modified.
#   current: Current data.
#   legacy: Whether or not this log was transferred from a Sonar v1 
#   instance. If so, the formatting will not match current version logs.
#   legacy_title: A title which is only populated on logs that were 
#   imported from Sonar v1.
#   level: The severity level.
#   loggable_id: The ID of the entity that this log is attached to.
#   loggable_type: The type of entity that this log is attached to.
#   logged_entity_id: The entity ID that triggered the log.
#   logged_entity_type: The entity that triggered the log.
#   message: The message.
#   previous: Previous data.
#   relation_data: Data from objects related to this change.
#   type: The type.
#   user_id: The ID of a User.
#   paginator: Provides the ability to paginate through results.
#   sorter: Provides the ability to sort results.
#   search: Complex search parameters.
#   general_search: Search across all string fields with partial 
#   matching.
#   aggregation: Provides the ability to return aggregated 
#   mathematical data about your results.
#   reverse_relation_filters: Reverse relation filters allow you to 
#   filter the result of a relation, and use that filter to affect the returned root 
#   elements.
logs(
id: Int64Bit,
sonar_unique_id: ID,
created_at: Datetime,
updated_at: Datetime,
_version: String,
current: Text,
legacy: Boolean,
legacy_title: String,
level: LogLevel,
loggable_id: Int64Bit,
loggable_type: String,
logged_entity_id: Int64Bit,
logged_entity_type: String,
message: Text,
previous: Text,
relation_data: Text,
type: LogType,
user_id: Int64Bit,
paginator: Paginator,
sorter: [Sorter],
search: [Search],
general_search: String,
aggregation: [Aggregator],
reverse_relation_filters: [ReverseRelationFilter]
): LogConnection! 
#   An access log history on an entity.
# 
# Arguments
#   id: The ID of the entity.
#   sonar_unique_id: An ID that uniquely identifies this entity 
#   across the whole Sonar system.
#   created_at: The date and time this entity was created.
#   updated_at: The last date and time this entity was modified.
#   _version: A string that shows the version of this entity. It 
#   will be incremented whenever the entity is modified.
#   access_datetime: The date and time that this entity was 
#   accessed.
#   accessloggable_id: The ID of the entity that this access log 
#   belongs to.
#   accessloggable_type: The entity that this access log belongs 
#   to.
#   entity_id: The ID of the entity that this access log belongs 
#   to.
#   entity_name: The entity that this access log belongs to.
#   user_id: The ID of the user that accessed this entity.
#   paginator: Provides the ability to paginate through results.
#   sorter: Provides the ability to sort results.
#   search: Complex search parameters.
#   general_search: Search across all string fields with partial 
#   matching.
#   aggregation: Provides the ability to return aggregated 
#   mathematical data about your results.
#   reverse_relation_filters: Reverse relation filters allow you to 
#   filter the result of a relation, and use that filter to affect the returned root 
#   elements.
access_logs(
id: Int64Bit,
sonar_unique_id: ID,
created_at: Datetime,
updated_at: Datetime,
_version: String,
access_datetime: Datetime,
accessloggable_id: Int64Bit,
accessloggable_type: String,
entity_id: Int64Bit,
entity_name: String,
user_id: Int64Bit,
paginator: Paginator,
sorter: [Sorter],
search: [Search],
general_search: String,
aggregation: [Aggregator],
reverse_relation_filters: [ReverseRelationFilter]
): AccessLogConnection! 
}
Contact

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
