Get all conversations

get

/crmRestApi/resources/11.13.18.05/conversations

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • ConversationByNumber Finds a conversation with the specified conversation number.
      Finder Variables
      • ConversationNumber; string; The alternate key identifier of the conversation.
    • ConversationsByPerson Finds a conversation with the specified finder variable.
      Finder Variables
      • SenderOrRecipientPartyId; integer; The unique identifier of the sender or recipient party.
    • PrimaryKey Finds a conversation with the specified primary key.
      Finder Variables
      • ConversationId; integer; The unique identifier of the conversation.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • BUOrgId; integer; The unique identifier of the business unit organization associated with the conversation.
    • ConversationAlternateId; string; The alternate unique identifier of the conversation.
    • ConversationId; integer; The unique identifier of the conversation.
    • ConversationNumber; string; The alternate key identifier of the conversation.
    • ConversationSortDate; string; The date field using which the conversation can be sorted. Currently it's the latest date when a message in the conversation was updated.
    • ConversationStatusCd; string; The code indicating the status of the conversation, such as OPEN or CLOSED.
    • ConversationStatusCdMeaning; string; The status of the conversation, such as Open or Closed.
    • ConversationTypeCd; string; The code indicating the type of the conversation, such as Customer or Collaboration.
    • CreatedBy; string; The user who created the conversation.
    • CreationDate; string; The date when the conversation was created.
    • LastUpdateDate; string; The date when the conversation was last updated.
    • LastUpdateLogin; string; The login details of the user who last updated the conversation.
    • LastUpdatedBy; string; The user who last updated the conversation.
    • OriginalSystemReference; string; A unique reference key of the conversation message from the original application.
    • OriginatedConversationId; integer; The unique identifier of the original conversation from which the current conversation was created.
    • OriginatedConversationNumber; string; The alternate key identifier of the original conversation from which the current conversation was created.
    • PrimaryMessageId; integer; The unique identifier of the primary message in the conversation.
    • PrimaryMessageNumber; string; The alternate key identifier of the primary message in the conversation.
    • PrimaryMessageTitle; string; The title of the primary message associated with the conversation.
    • StripeCd; string; The code indicating the application stripe of the conversation, such as CRM, HRHD, or ISR.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : conversations
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : conversations-item-response
Type: object
Show Source
Nested Schema : Conversation References
Type: array
Title: Conversation References
Conversation references.
Show Source
Nested Schema : conversations-conversationReferences-item-response
Type: object
Show Source
  • Title: Conversation ID
    The unique identifier of the conversation with which the business object is associated.
  • Title: Conversation Number
    Maximum Length: 30
    The alternate key identifier of the conversation with which the business object is associated.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the conversation reference.
  • Title: Creation Date
    Read Only: true
    The date when the conversation reference was created.
  • Title: Last Updated Date
    Read Only: true
    The date when the conversation reference was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the conversation reference.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login details of the user who last updated the conversation reference.
  • Links
  • Title: Object ID
    The unique identifier of the business object associated with the conversation.
  • Title: Object Number
    Maximum Length: 255
    The alternate key identifier of the business object associated with the conversation.
  • Title: Object Type
    Maximum Length: 30
    The code indicating the type of the business object associated with the conversation, such as SVC_SERVICE_REQUESTS.
  • Title: Object Type
    Read Only: true
    Maximum Length: 255
    The object type, such as Opportunity, Service Request, Activity, Sales Lead or Account.
  • Title: Reference ID
    Read Only: true
    The unique identifier of the conversation reference.
  • Title: Reference Number
    Maximum Length: 30
    The public unique identifier of the conversation reference.
Back to Top