Headers

• organization string Required

  id of the selected (active) organization

Path parameters

• orgId string Required

  ID of the organization

• caseId string Required

  ID of the case

Query parameters

• page number

  Default value is 1.

• perPage number

  Default value is 10.

• skip number

  If skip/limit not provided, page/perPage will take precedence

• limit number

  If skip/limit not provided, page/perPage will take precedence

• sortOrder string

  Values are asc or desc. Default value is asc.

• searchText string

  Minimum length is 3, maximum length is 100.

• conversation string
• device string
• sortBy string

  Values are createdAt, updatedAt, or name. Default value is name.

Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • data object Required
    Hide data attributes Show data attributes object

    • total number Required
    • page number
    • perPage number
    • skip number
    • limit number
    • totalPages number Required
    • nextPage number | null Required
    • previousPage number | null Required
    • data array[object]
      Hide data attributes Show data attributes object

      • createdAt string(date-time) Required
      • updatedAt string(date-time) Required
      • id string Required
      • fullName string Required
      • firstName string Required
      • lastName string Required
      • originalFullName string Required
      • email string Required
      • address string Required
      • phone array[string] Required
      • phoneNational array[string] Required
      • source string Required

        Values are default, message, device_contact, whatsapp, voicemail, call_log, social, facebook, instagram, or threads.

      • linkedContacts array[object] | null Required

        The full record on routes that load it; null (or an empty list) on routes that do not.
      • avatar object Required

        The full record on routes that load it; null (or an empty list) on routes that do not.

        Hide avatar attributes Show avatar attributes object

        • createdAt string(date-time) Required
        • updatedAt string(date-time) Required
        • id string Required
        • name string Required
        • providerId string Required
        • convertedName string | null Required
        • convertedProviderId string Required
        • provider string Required
        • size number Required

          Size in bytes

        • transferState number | null Required
      • device object Required

        The full record on routes that load it; null (or an empty list) on routes that do not.

        Hide device attributes Show device attributes object

        • createdAt string(date-time) Required
        • updatedAt string(date-time) Required
        • id string Required
        • deviceId string Required
        • serialNumber string Required
        • name string Required
        • type string Required
        • nonDeviceType string | null Required
        • model string Required
        • timeZone string Required
        • osVersion string Required
        • owner object | null Required

          Not loaded by any route, so always null.

        • devicePhoneNumber string Required
        • organizations array[string] Required

          Organization ids

        • extractionCodes array[string] Required

          Extraction code ids

        • availableData object

          Which data types exist for this device (optionally scoped by query filters).

      • owner object Required

        The full record on routes that load it; null (or an empty list) on routes that do not.

        Hide owner attributes Show owner attributes object

        • createdAt string(date-time) Required
        • updatedAt string(date-time) Required
        • id string Required
        • name string Required
        • email string Required
        • phone array[string] Required
        • isActive boolean Required
        • isEmailVerified boolean Required
        • lastActive string(date-time) Required
        • roles array[string] Required
        • avatar object Required

          The full record on routes that load it; null (or an empty list) on routes that do not.

          Hide avatar attributes Show avatar attributes object

          • createdAt string(date-time) Required
          • updatedAt string(date-time) Required
          • id string Required
          • name string Required
          • providerId string Required
          • convertedName string | null Required
          • convertedProviderId string Required
          • provider string Required
          • size number Required

            Size in bytes

          • transferState number | null Required
        • onboardingStatus string | null Required
        • userType string | null Required
        • firstName string Required
        • lastName string Required
        • initials string Required
        • userOrganizations array[object]

          Only filled on the signed-in user's own profile; absent or empty on a user nested in another record.
      • initials string Required
      • conversations array[string]
      • isEdited boolean Required

        True when the name differs from the one on the device

  • statusCode number Required
  • timestamp string(date-time) Required