Constructors

Methods

  • This endpoint allows you to query for event instances using filter criteria. Event Instance Query

    Parameters

    • OptionalobjectType: string

      The CRM Object type name to filter event instances on. Optionally, you can also provide an objectId in another param to filter to a specific CRM Object instance.

    • OptionaleventType: string

      The event type name. A list of available event type names can be obtained from another API call.

    • Optionalafter: string

      The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.

    • Optionalbefore: string
    • Optionallimit: number

      The maximum number of results to display per page.

    • Optionalsort: string[]

      Sort direction based on the timestamp of the event instance, ASCENDING or DESCENDING.

    • OptionaloccurredAfter: Date
    • OptionaloccurredBefore: Date
    • OptionalobjectId: number

      The ID of the CRM Object to filter event instances on. If filtering on objectId, you must also provide an objectType.

    • OptionalobjectPropertyPropname: any
    • OptionalpropertyPropname: any
    • Optionalid: string[]

      ID of an event instance. IDs are 1:1 with event instances. If you. provide this filter and additional filters, the other filters must match the values on the event instance to yield results.

    • Optional_options: Configuration

    Returns Promise<CollectionResponseExternalUnifiedEvent>

  • This endpoint allows you to query for event instances using filter criteria. Event Instance Query

    Parameters

    • OptionalobjectType: string

      The CRM Object type name to filter event instances on. Optionally, you can also provide an objectId in another param to filter to a specific CRM Object instance.

    • OptionaleventType: string

      The event type name. A list of available event type names can be obtained from another API call.

    • Optionalafter: string

      The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.

    • Optionalbefore: string
    • Optionallimit: number

      The maximum number of results to display per page.

    • Optionalsort: string[]

      Sort direction based on the timestamp of the event instance, ASCENDING or DESCENDING.

    • OptionaloccurredAfter: Date
    • OptionaloccurredBefore: Date
    • OptionalobjectId: number

      The ID of the CRM Object to filter event instances on. If filtering on objectId, you must also provide an objectType.

    • OptionalobjectPropertyPropname: any
    • OptionalpropertyPropname: any
    • Optionalid: string[]

      ID of an event instance. IDs are 1:1 with event instances. If you. provide this filter and additional filters, the other filters must match the values on the event instance to yield results.

    • Optional_options: Configuration

    Returns Promise<HttpInfo<CollectionResponseExternalUnifiedEvent>>