DOCSEARCHbyAlgolia
Submit Docs

Cirrus CRM Documentation

website·Indexed 32 days ago

https://docs.cirruscrm.io

Developer documentation for Cirrus CRM, featuring a comprehensive GraphQL API reference for managing orders, opportunities, missions, and users, as well as guides for webhook signature validation.

Tokens
110.1K
Snippets
777
Records
1.3K
Agent score
51%

What's inside Cirrus CRM

  1. Reference the Mission GraphQL object

    The Mission object represents a mission entity in Cirrus CRM. It contains metadata about the mission (name, description, dates), ownership, and several paginated connections to related entities like accounts, activities, articles, orders, progress, and users.
    type Mission {
  accounts(after: String, first: Int): MissionAccountConnection
  active: Boolean
  activities(after: String, filter: MissionActivityFilterInput, first: Int): MissionActivityConnection
  articles(after: String, first: Int): MissionArticleConnection
  description: String
  end: Date!
  id: ID!
  name: String!
  orders(after: String, first: Int): MissionOrderConnection
  owner: User
  pdf: String
  progress(after: String, first: Int): MissionProgressConnection
  script: String
  start: Date!
  terms: String
  type: MissionType
  users(after: String, first: Int): MissionUserConnection
  video: String
}

  2. Query fields for the MissionProgress GraphQL object

    The MissionProgress object provides information about the progress of a mission, including the associated account and activity timestamps.
    type MissionProgress {
  account: Account!
  lastActivity: DateTime
  latestActivity: Activity
}

  3. Retrieve the current user using the Viewer GraphQL object

    The Viewer object represents the current authenticated user in the Cirrus CRM GraphQL API. It can be retrieved using the viewer query. The object provides identity details, localization settings, and account-specific metrics like overdue counts.
    query {
  viewer {
    id
    fullName
    customerId
    locale
    name
    overdueCount
    intercomUserHash(platform: "web")
  }
}

  4. Reference the DynamicFieldGroup GraphQL object

    The DynamicFieldGroup object represents a group of dynamic fields within the Cirrus CRM GraphQL API. It contains metadata about the group, including its unique identifier, name, and timestamps for creation and last update.
    type DynamicFieldGroup {
  created: DateTime
  id: ID
  name: String
  updated: DateTime
}

  5. PriceList GraphQL object reference

    The PriceList object represents a pricing configuration in Cirrus CRM. It contains metadata about the price list, its validity period, and the associated article prices.
    type PriceList {
  active: Boolean
  default: Boolean
  description: String
  externalKey: String
  id: ID
  name: String
  prices: [ArticlePrice]
  start: DateTime
  stop: DateTime
  strict: Boolean
}

  6. Use the FileConnection object for paginated file queries

    The FileConnection object is returned by the files query. It provides a paginated list of files along with metadata about the result set, including the total count of files and pagination state.
    type FileConnection {
  edges: [FileEdge]
  pageInfo: PageInfo
  totalCount: Int
}

  7. Reference the CreditCheck GraphQL object fields

    The CreditCheck object provides details about a credit check operation, including its execution date, tracking identifiers, and the resulting status and outcome.
    type CreditCheck {
  checkDate: DateTime
  correlationId: String
  outcome: String
  status: String
}

  8. Activity GraphQL object reference

    The Activity object represents a task, event, or interaction within Cirrus CRM. It contains details about the activity's timing, participants, associated business entities (accounts, contacts, opportunities), and its current state.
    type Activity {
  account: ActivityAccount
  answers: [ActivityTypeAnswer!]
  closed: Boolean
  contact: Contact
  description: String
  dynamicFields: [DynamicField]
  endTime: String
  externalKey: String
  following: Boolean
  id: Int
  invitedUsers: [User]
  location: String
  opportunity: Opportunity
  progressionStateId: Int
  result: String
  scheduledDate: String
  startTime: String
  suggestedFollowup: FollowupActivity
  tags: [Tag!]
  type: ActivityType
  user: User
  userId: Int
  visibility: Visibility
}

  9. Understand File object fields

    The File object contains the following fields:

    • content: The contents of the file encoded as a base64 string.
    • id: The unique identifier for the file (non-null).
    • info: Additional information about the file.
    • name: The name of the file (non-null).
    • template: Associated FileTemplate object.
    • timestamp: A DateTime object indicating when the file was created or modified.

  10. Use global date and user expressions in Order templates

    The following expressions provide metadata about the time and user context when an Order template is generated:
    {{currentDate}}       // Date when the template is generated
{{currentTime}}       // Time when the template is generated
{{currentUser}}       // Username of the user generating the template
{{currentYear}}       // Year the template is generated
{{date.day}}          // Day the template is generated
{{date.iso}}          // ISO8601 date string
{{date.month}}         // Month (JAN, FEB, ...)
{{date.monthNumber}}   // Month number (1-12)
{{date.year}}          // Year

  11. Use the BankIDCompletionData GraphQL object

    The BankIDCompletionData object provides detailed information about a BankID completion process. It is a member of the BankIDSign object and contains the following fields:

    • cert: A BankIDCompletionCertificate object.
    • ocspResponse: A BankIDCompletionOcspResponse object.
    • signature: A BankIDCompletionSignature object.
    • user: A BankIDCompletionUser object.
    • device: A BankIDCompletionDevice object (Deprecated).
    type BankIDCompletionData {
  cert: BankIDCompletionCertificate
  device: BankIDCompletionDevice @deprecated
  ocspResponse: BankIDCompletionOcspResponse
  signature: BankIDCompletionSignature
  user: BankIDCompletionUser
}

  12. Reference the DynamicField GraphQL object

    The DynamicField object is used across various Cirrus CRM entities (such as Account, Activity, Article, Contact, Lead, Object, Opportunity, Order, and Quote) to represent customizable fields. It contains metadata about the field's constraints, visibility, and its current value.
    type DynamicField {
  choices: [DynamicFieldChoice]
  fieldType: String
  id: Int!
  name: String
  readOnly: Boolean!
  required: Boolean!
  type: DynamicFieldType!
  value: DynamicValue
  visible: Boolean!
}