CFM Survey Search API V3 Developer Guide

Applies to: Sprinklr Customer Feedback Management (CFM) Survey Search API V3
Method: POST
Resource: /api/v3/search/cfmSurvey

1. Overview

Use the CFM Survey Search API to retrieve surveys available to the authenticated user. You can narrow the results by program hierarchy, status, survey name, owner, creation time, or modification time. The API also supports multiple filters and pagination.

2. API endpoint

POST https://api3.sprinklr.com/{env}/api/v3/search/cfmSurvey

Replace {env} with your assigned Sprinklr environment identifier.

3. Authentication and headers

Header	Type	Required	Description
`Authorization`	String	Yes	Bearer token used to authenticate the API request.
`Content-Type`	String	Yes	Media type of the request body. Use `application/json`.
`Accept`	String	Yes	Expected response format. Use `application/json`.
`Cookie`	String	Conditional	Session cookie containing `JSESSIONID`, when required for the environment.

Security: Replace all sample credentials with your own values. Do not publish or store access tokens or session IDs in documentation, source control, tickets, or chat.

4. Request body

4.1 Request parameters

Parameter	Sub-parameter	Type	Required	Description
`page`	-	Object	No	Controls pagination for the survey search results.
`page`	`size`	Integer	No	Maximum number of survey records returned in the response.
`page`	`start`	Integer	No	Zero-based index from which records are returned.
`filter`	-	Object	Yes	Defines the search criteria used to retrieve surveys.
`filter`	`type`	String	Yes	Logical operator used to combine filter conditions. The examples use `AND`.
`filter`	`filters`	Array<Object>	Yes	List of filter conditions applied to the search. An empty array returns accessible surveys without field-level filtering.
`filters[]`	`type`	String	Yes	Filter operator, such as `EQUALS`, `CONTAINS`, `GT`, or `LT`.
`filters[]`	`key`	String	Yes	Survey field to which the filter is applied.
`filters[]`	`values`	Array	Yes	Values evaluated against the selected key.

4.2 Supported filters demonstrated in this guide

Filter key	Operator	Value type	Purpose
`parentHierarchyIds`	`EQUALS`	Array<String>	Retrieves surveys associated with the specified program hierarchy.
`status`	`EQUALS`	Array<String>	Retrieves surveys in the specified status, such as `ACTIVE` or `DRAFT`.
`name`	`CONTAINS`	Array<String>	Retrieves surveys whose names contain the specified text.
`ownerUserId`	`EQUALS`	Array<String>	Retrieves surveys owned by the specified user ID.
`createdTime`	`GT`, `LT`, `EQUALS`	Array<Long>	Compares the survey creation time with an epoch timestamp in milliseconds.
`modifiedTime`	`GT`	Array<String>	Retrieves surveys modified after the specified epoch timestamp in milliseconds.

5. Search examples

5.1 Filter by program and status

Retrieves active surveys associated with a specified program hierarchy.

curl --location 'https://api3.sprinklr.com/{env}/api/v3/search/cfmSurvey' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer {{accessToken}}' \
  --header 'Cookie: JSESSIONID={{JSESSIONID}}' \
  --data '{
    "filter": {
      "type": "AND",
      "filters": [
        {
          "type": "EQUALS",
          "key": "parentHierarchyIds",
          "values": ["6a79a1637bac8dce7930723d"]
        },
        {
          "type": "EQUALS",
          "key": "status",
          "values": ["ACTIVE"]
        }
      ]
    }
  }'

Request parameters for this example

Parameter	Sub-parameter	Type	Required	Description
`filter`	-	Object	Yes	Defines the search criteria used to retrieve surveys.
`filter`	`type`	String	Yes	Logical operator used to combine filter conditions. This example uses `AND`.
`filter`	`filters`	Array<Object>	Yes	List of filter conditions applied to the survey search.
`filters[]`	`type`	String	Yes	Uses `EQUALS` for exact matching.
`filters[]`	`key`	String	Yes	Uses `parentHierarchyIds` and `status`.
`filters[]`	`values`	Array<String>	Yes	Hierarchy ID and `ACTIVE` status values.

Example response

{
  "data": {
    "results": []
  },
  "errors": []
}

An empty results array indicates that no surveys matched the supplied filter criteria.

Response parameters for this example

Parameter	Sub-parameter	Type	Description
`data`	-	Object	Contains the survey search response.
`data`	`results`	Array<Object>	Contains surveys matching the request. Returns an empty array when no records match.
`results[]`	`id`	String	Unique identifier of the survey.
`results[]`	`name`	String	Name of the survey.
`results[]`	`parentProgramId`	String	Unique identifier of the parent program.
`results[]`	`parentProgramName`	String	Name of the parent program.
`results[]`	`status`	String	Current survey status, when returned.
`results[]`	`ownerUserId`	Long	Unique identifier of the survey owner.
`results[]`	`createdTime`	String	Date and time when the survey was created.
`results[]`	`modifiedTime`	String	Date and time when the survey was last modified.
`results[]`	`modifiedBy`	Long	Identifier of the user who last modified the survey.
`results[]`	`baseLanguage`	String	Base language configured for the survey.
`results[]`	`parentHierarchyIds`	Array<String>	Hierarchy IDs associated with the survey.
`results[]`	`surveyLanguages`	Array<String>	Additional language codes configured for the survey.
`errors`	-	Array<Object>	Contains error details. Returns an empty array when no errors are reported.

5.2 Filter by status

Retrieves surveys whose status is DRAFT.

{
  "filter": {
    "type": "AND",
    "filters": [
      {
        "type": "EQUALS",
        "key": "status",
        "values": ["DRAFT"]
      }
    ]
  }
}

Request parameters for this example

Parameter	Sub-parameter	Type	Required	Description
`filter`	-	Object	Yes	Defines the search criteria used to retrieve surveys.
`filter`	`type`	String	Yes	Logical operator used to combine filter conditions. This example uses `AND`.
`filter`	`filters`	Array<Object>	Yes	List of filter conditions applied to the survey search.
`filters[]`	`type`	String	Yes	Uses `EQUALS` for exact matching.
`filters[]`	`key`	String	Yes	Uses the `status` field.
`filters[]`	`values`	Array<String>	Yes	Status values to match, such as `DRAFT`.

Example response

{
  "data": {
    "results": [
      {
        "id": "673c3e996e59f506defadd5a",
        "name": "mobile web count",
        "parentProgramId": "671b8ed98164750a00553356",
        "parentProgramName": "Testing DND",
        "status": "ACTIVE",
        "ownerUserId": 66011409,
        "createdTime": "Oct 30, 2025, 08:54:30 AM",
        "modifiedTime": "Sep 11, 2026, 01:31:47 PM",
        "modifiedBy": 66011409,
        "baseLanguage": "en",
        "parentHierarchyIds": [
          "671b8ed98164750a00553356"
        ],
        "surveyLanguages": [
          "hi"
        ]
      }
    ]
  },
  "errors": []
}

A populated results array contains the surveys that matched the request filters.

Response parameters for this example

Parameter	Sub-parameter	Type	Description
`data`	-	Object	Contains the survey search response.
`data`	`results`	Array<Object>	Contains surveys matching the request. Returns an empty array when no records match.
`results[]`	`id`	String	Unique identifier of the survey.
`results[]`	`name`	String	Name of the survey.
`results[]`	`parentProgramId`	String	Unique identifier of the parent program.
`results[]`	`parentProgramName`	String	Name of the parent program.
`results[]`	`status`	String	Current survey status, when returned.
`results[]`	`ownerUserId`	Long	Unique identifier of the survey owner.
`results[]`	`createdTime`	String	Date and time when the survey was created.
`results[]`	`modifiedTime`	String	Date and time when the survey was last modified.
`results[]`	`modifiedBy`	Long	Identifier of the user who last modified the survey.
`results[]`	`baseLanguage`	String	Base language configured for the survey.
`results[]`	`parentHierarchyIds`	Array<String>	Hierarchy IDs associated with the survey.
`results[]`	`surveyLanguages`	Array<String>	Additional language codes configured for the survey.
`errors`	-	Array<Object>	Contains error details. Returns an empty array when no errors are reported.

5.3 Filter by creation time using `LT`

Retrieves surveys created before the specified epoch timestamp.

{
  "filter": {
    "type": "AND",
    "filters": [
      {
        "type": "LT",
        "key": "createdTime",
        "values": [1787553659989]
      }
    ]
  }
}

Request parameters for this example

Parameter	Sub-parameter	Type	Required	Description
`filter`	-	Object	Yes	Defines the search criteria used to retrieve surveys.
`filter`	`type`	String	Yes	Logical operator used to combine filter conditions. This example uses `AND`.
`filter`	`filters`	Array<Object>	Yes	List of filter conditions applied to the survey search.
`filters[]`	`type`	String	Yes	Uses `LT` to match earlier values.
`filters[]`	`key`	String	Yes	Uses the `createdTime` field.
`filters[]`	`values`	Array<Long>	Yes	Epoch timestamp in milliseconds.

Example response

{
  "data": {
    "results": [
      {
        "id": "673c3e996e59f506defadd5a",
        "name": "mobile web count",
        "parentProgramId": "671b8ed98164750a00553356",
        "parentProgramName": "Testing DND",
        "status": "ACTIVE",
        "ownerUserId": 66011409,
        "createdTime": "Oct 30, 2025, 08:54:30 AM",
        "modifiedTime": "Sep 11, 2026, 01:31:47 PM",
        "modifiedBy": 66011409,
        "baseLanguage": "en",
        "parentHierarchyIds": [
          "671b8ed98164750a00553356"
        ],
        "surveyLanguages": [
          "hi"
        ]
      }
    ]
  },
  "errors": []
}

A populated results array contains the surveys that matched the request filters.

Response parameters for this example

Parameter	Sub-parameter	Type	Description
`data`	-	Object	Contains the survey search response.
`data`	`results`	Array<Object>	Contains surveys matching the request. Returns an empty array when no records match.
`results[]`	`id`	String	Unique identifier of the survey.
`results[]`	`name`	String	Name of the survey.
`results[]`	`parentProgramId`	String	Unique identifier of the parent program.
`results[]`	`parentProgramName`	String	Name of the parent program.
`results[]`	`status`	String	Current survey status, when returned.
`results[]`	`ownerUserId`	Long	Unique identifier of the survey owner.
`results[]`	`createdTime`	String	Date and time when the survey was created.
`results[]`	`modifiedTime`	String	Date and time when the survey was last modified.
`results[]`	`modifiedBy`	Long	Identifier of the user who last modified the survey.
`results[]`	`baseLanguage`	String	Base language configured for the survey.
`results[]`	`parentHierarchyIds`	Array<String>	Hierarchy IDs associated with the survey.
`results[]`	`surveyLanguages`	Array<String>	Additional language codes configured for the survey.
`errors`	-	Array<Object>	Contains error details. Returns an empty array when no errors are reported.

5.4 Filter by survey name

Retrieves surveys whose names contain the specified text.

{
  "filter": {
    "type": "AND",
    "filters": [
      {
        "type": "CONTAINS",
        "key": "name",
        "values": ["survey"]
      }
    ]
  }
}

Request parameters for this example

Parameter	Sub-parameter	Type	Required	Description
`filter`	-	Object	Yes	Defines the search criteria used to retrieve surveys.
`filter`	`type`	String	Yes	Logical operator used to combine filter conditions. This example uses `AND`.
`filter`	`filters`	Array<Object>	Yes	List of filter conditions applied to the survey search.
`filters[]`	`type`	String	Yes	Uses `CONTAINS` for partial text matching.
`filters[]`	`key`	String	Yes	Uses the `name` field.
`filters[]`	`values`	Array<String>	Yes	Text that the survey name must contain.

Example response

{
  "data": {
    "results": []
  },
  "errors": []
}

An empty results array indicates that no surveys matched the supplied filter criteria.

Response parameters for this example

Parameter	Sub-parameter	Type	Description
`data`	-	Object	Contains the survey search response.
`data`	`results`	Array<Object>	Contains surveys matching the request. Returns an empty array when no records match.
`results[]`	`id`	String	Unique identifier of the survey.
`results[]`	`name`	String	Name of the survey.
`results[]`	`parentProgramId`	String	Unique identifier of the parent program.
`results[]`	`parentProgramName`	String	Name of the parent program.
`results[]`	`status`	String	Current survey status, when returned.
`results[]`	`ownerUserId`	Long	Unique identifier of the survey owner.
`results[]`	`createdTime`	String	Date and time when the survey was created.
`results[]`	`modifiedTime`	String	Date and time when the survey was last modified.
`results[]`	`modifiedBy`	Long	Identifier of the user who last modified the survey.
`results[]`	`baseLanguage`	String	Base language configured for the survey.
`results[]`	`parentHierarchyIds`	Array<String>	Hierarchy IDs associated with the survey.
`results[]`	`surveyLanguages`	Array<String>	Additional language codes configured for the survey.
`errors`	-	Array<Object>	Contains error details. Returns an empty array when no errors are reported.

5.5 Filter by program hierarchy

Retrieves surveys associated with the specified hierarchy identifier.

{
  "filter": {
    "type": "AND",
    "filters": [
      {
        "type": "EQUALS",
        "key": "parentHierarchyIds",
        "values": ["6a79a1637bac8dce7930723d"]
      }
    ]
  }
}

Request parameters for this example

Parameter	Sub-parameter	Type	Required	Description
`filter`	-	Object	Yes	Defines the search criteria used to retrieve surveys.
`filter`	`type`	String	Yes	Logical operator used to combine filter conditions. This example uses `AND`.
`filter`	`filters`	Array<Object>	Yes	List of filter conditions applied to the survey search.
`filters[]`	`type`	String	Yes	Uses `EQUALS` for exact matching.
`filters[]`	`key`	String	Yes	Uses the `parentHierarchyIds` field.
`filters[]`	`values`	Array<String>	Yes	Program hierarchy IDs to match.

Example response

{
  "data": {
    "results": []
  },
  "errors": []
}

An empty results array indicates that no surveys matched the supplied filter criteria.

Response parameters for this example

Parameter	Sub-parameter	Type	Description
`data`	-	Object	Contains the survey search response.
`data`	`results`	Array<Object>	Contains surveys matching the request. Returns an empty array when no records match.
`results[]`	`id`	String	Unique identifier of the survey.
`results[]`	`name`	String	Name of the survey.
`results[]`	`parentProgramId`	String	Unique identifier of the parent program.
`results[]`	`parentProgramName`	String	Name of the parent program.
`results[]`	`status`	String	Current survey status, when returned.
`results[]`	`ownerUserId`	Long	Unique identifier of the survey owner.
`results[]`	`createdTime`	String	Date and time when the survey was created.
`results[]`	`modifiedTime`	String	Date and time when the survey was last modified.
`results[]`	`modifiedBy`	Long	Identifier of the user who last modified the survey.
`results[]`	`baseLanguage`	String	Base language configured for the survey.
`results[]`	`parentHierarchyIds`	Array<String>	Hierarchy IDs associated with the survey.
`results[]`	`surveyLanguages`	Array<String>	Additional language codes configured for the survey.
`errors`	-	Array<Object>	Contains error details. Returns an empty array when no errors are reported.

5.6 Filter by modification time

Retrieves surveys modified after the specified epoch timestamp.

{
  "filter": {
    "type": "AND",
    "filters": [
      {
        "type": "GT",
        "key": "modifiedTime",
        "values": ["1735669800000"]
      }
    ]
  }
}

Request parameters for this example

Parameter	Sub-parameter	Type	Required	Description
`filter`	-	Object	Yes	Defines the search criteria used to retrieve surveys.
`filter`	`type`	String	Yes	Logical operator used to combine filter conditions. This example uses `AND`.
`filter`	`filters`	Array<Object>	Yes	List of filter conditions applied to the survey search.
`filters[]`	`type`	String	Yes	Uses `GT` to match later values.
`filters[]`	`key`	String	Yes	Uses the `modifiedTime` field.
`filters[]`	`values`	Array<String>	Yes	Epoch timestamp in milliseconds, represented as a string in this example.

Example response

{
  "data": {
    "results": [
      {
        "id": "673c3e996e59f506defadd5a",
        "name": "mobile web count",
        "parentProgramId": "671b8ed98164750a00553356",
        "parentProgramName": "Testing DND",
        "status": "ACTIVE",
        "ownerUserId": 66011409,
        "createdTime": "Oct 30, 2025, 08:54:30 AM",
        "modifiedTime": "Sep 11, 2026, 01:31:47 PM",
        "modifiedBy": 66011409,
        "baseLanguage": "en",
        "parentHierarchyIds": [
          "671b8ed98164750a00553356"
        ],
        "surveyLanguages": [
          "hi"
        ]
      }
    ]
  },
  "errors": []
}

A populated results array contains the surveys that matched the request filters.

Response parameters for this example

Parameter	Sub-parameter	Type	Description
`data`	-	Object	Contains the survey search response.
`data`	`results`	Array<Object>	Contains surveys matching the request. Returns an empty array when no records match.
`results[]`	`id`	String	Unique identifier of the survey.
`results[]`	`name`	String	Name of the survey.
`results[]`	`parentProgramId`	String	Unique identifier of the parent program.
`results[]`	`parentProgramName`	String	Name of the parent program.
`results[]`	`status`	String	Current survey status, when returned.
`results[]`	`ownerUserId`	Long	Unique identifier of the survey owner.
`results[]`	`createdTime`	String	Date and time when the survey was created.
`results[]`	`modifiedTime`	String	Date and time when the survey was last modified.
`results[]`	`modifiedBy`	Long	Identifier of the user who last modified the survey.
`results[]`	`baseLanguage`	String	Base language configured for the survey.
`results[]`	`parentHierarchyIds`	Array<String>	Hierarchy IDs associated with the survey.
`results[]`	`surveyLanguages`	Array<String>	Additional language codes configured for the survey.
`errors`	-	Array<Object>	Contains error details. Returns an empty array when no errors are reported.

5.7 Retrieve accessible surveys without field-level filters

{
  "filter": {
    "type": "AND",
    "filters": []
  }
}

Request parameters for this example

Parameter	Sub-parameter	Type	Required	Description
`filter`	-	Object	Yes	Defines the search criteria used to retrieve surveys.
`filter`	`type`	String	Yes	Logical operator used to combine filter conditions. This example uses `AND`.
`filter`	`filters`	Array<Object>	Yes	List of filter conditions applied to the survey search.

Example response

{
  "data": {
    "results": [
      {
        "id": "673c3e996e59f506defadd5a",
        "name": "mobile web count",
        "parentProgramId": "671b8ed98164750a00553356",
        "parentProgramName": "Testing DND",
        "status": "ACTIVE",
        "ownerUserId": 66011409,
        "createdTime": "Oct 30, 2025, 08:54:30 AM",
        "modifiedTime": "Sep 11, 2026, 01:31:47 PM",
        "modifiedBy": 66011409,
        "baseLanguage": "en",
        "parentHierarchyIds": [
          "671b8ed98164750a00553356"
        ],
        "surveyLanguages": [
          "hi"
        ]
      }
    ]
  },
  "errors": []
}

A populated results array contains the surveys that matched the request filters.

Response parameters for this example

Parameter	Sub-parameter	Type	Description
`data`	-	Object	Contains the survey search response.
`data`	`results`	Array<Object>	Contains surveys matching the request. Returns an empty array when no records match.
`results[]`	`id`	String	Unique identifier of the survey.
`results[]`	`name`	String	Name of the survey.
`results[]`	`parentProgramId`	String	Unique identifier of the parent program.
`results[]`	`parentProgramName`	String	Name of the parent program.
`results[]`	`status`	String	Current survey status, when returned.
`results[]`	`ownerUserId`	Long	Unique identifier of the survey owner.
`results[]`	`createdTime`	String	Date and time when the survey was created.
`results[]`	`modifiedTime`	String	Date and time when the survey was last modified.
`results[]`	`modifiedBy`	Long	Identifier of the user who last modified the survey.
`results[]`	`baseLanguage`	String	Base language configured for the survey.
`results[]`	`parentHierarchyIds`	Array<String>	Hierarchy IDs associated with the survey.
`results[]`	`surveyLanguages`	Array<String>	Additional language codes configured for the survey.
`errors`	-	Array<Object>	Contains error details. Returns an empty array when no errors are reported.

5.8 Filter by survey owner

{
  "filter": {
    "type": "AND",
    "filters": [
      {
        "type": "EQUALS",
        "key": "ownerUserId",
        "values": ["66069496"]
      }
    ]
  }
}

Request parameters for this example

Parameter	Sub-parameter	Type	Required	Description
`filter`	-	Object	Yes	Defines the search criteria used to retrieve surveys.
`filter`	`type`	String	Yes	Logical operator used to combine filter conditions. This example uses `AND`.
`filter`	`filters`	Array<Object>	Yes	List of filter conditions applied to the survey search.
`filters[]`	`type`	String	Yes	Uses `EQUALS` for exact matching.
`filters[]`	`key`	String	Yes	Uses the `ownerUserId` field.
`filters[]`	`values`	Array<String>	Yes	Owner user IDs to match.

Example response

{
  "data": {
    "results": []
  },
  "errors": []
}

An empty results array indicates that no surveys matched the supplied filter criteria.

Response parameters for this example

Parameter	Sub-parameter	Type	Description
`data`	-	Object	Contains the survey search response.
`data`	`results`	Array<Object>	Contains surveys matching the request. Returns an empty array when no records match.
`results[]`	`id`	String	Unique identifier of the survey.
`results[]`	`name`	String	Name of the survey.
`results[]`	`parentProgramId`	String	Unique identifier of the parent program.
`results[]`	`parentProgramName`	String	Name of the parent program.
`results[]`	`status`	String	Current survey status, when returned.
`results[]`	`ownerUserId`	Long	Unique identifier of the survey owner.
`results[]`	`createdTime`	String	Date and time when the survey was created.
`results[]`	`modifiedTime`	String	Date and time when the survey was last modified.
`results[]`	`modifiedBy`	Long	Identifier of the user who last modified the survey.
`results[]`	`baseLanguage`	String	Base language configured for the survey.
`results[]`	`parentHierarchyIds`	Array<String>	Hierarchy IDs associated with the survey.
`results[]`	`surveyLanguages`	Array<String>	Additional language codes configured for the survey.
`errors`	-	Array<Object>	Contains error details. Returns an empty array when no errors are reported.

5.9 Filter by creation time using `GT`

Retrieves surveys created after the specified epoch timestamp.

{
  "filter": {
    "type": "AND",
    "filters": [
      {
        "type": "GT",
        "key": "createdTime",
        "values": [1787553659989]
      }
    ]
  }
}

Request parameters for this example

Parameter	Sub-parameter	Type	Required	Description
`filter`	-	Object	Yes	Defines the search criteria used to retrieve surveys.
`filter`	`type`	String	Yes	Logical operator used to combine filter conditions. This example uses `AND`.
`filter`	`filters`	Array<Object>	Yes	List of filter conditions applied to the survey search.
`filters[]`	`type`	String	Yes	Uses `GT` to match later values.
`filters[]`	`key`	String	Yes	Uses the `createdTime` field.
`filters[]`	`values`	Array<Long>	Yes	Epoch timestamp in milliseconds.

Example response

{
  "data": {
    "results": []
  },
  "errors": []
}

An empty results array indicates that no surveys matched the supplied filter criteria.

Response parameters for this example

Parameter	Sub-parameter	Type	Description
`data`	-	Object	Contains the survey search response.
`data`	`results`	Array<Object>	Contains surveys matching the request. Returns an empty array when no records match.
`results[]`	`id`	String	Unique identifier of the survey.
`results[]`	`name`	String	Name of the survey.
`results[]`	`parentProgramId`	String	Unique identifier of the parent program.
`results[]`	`parentProgramName`	String	Name of the parent program.
`results[]`	`status`	String	Current survey status, when returned.
`results[]`	`ownerUserId`	Long	Unique identifier of the survey owner.
`results[]`	`createdTime`	String	Date and time when the survey was created.
`results[]`	`modifiedTime`	String	Date and time when the survey was last modified.
`results[]`	`modifiedBy`	Long	Identifier of the user who last modified the survey.
`results[]`	`baseLanguage`	String	Base language configured for the survey.
`results[]`	`parentHierarchyIds`	Array<String>	Hierarchy IDs associated with the survey.
`results[]`	`surveyLanguages`	Array<String>	Additional language codes configured for the survey.
`errors`	-	Array<Object>	Contains error details. Returns an empty array when no errors are reported.

5.10 Filter by exact creation time

Retrieves surveys whose creation time exactly matches the specified epoch timestamp.

{
  "filter": {
    "type": "AND",
    "filters": [
      {
        "type": "EQUALS",
        "key": "createdTime",
        "values": [1787554226496]
      }
    ]
  }
}

Request parameters for this example

Parameter	Sub-parameter	Type	Required	Description
`filter`	-	Object	Yes	Defines the search criteria used to retrieve surveys.
`filter`	`type`	String	Yes	Logical operator used to combine filter conditions. This example uses `AND`.
`filter`	`filters`	Array<Object>	Yes	List of filter conditions applied to the survey search.
`filters[]`	`type`	String	Yes	Uses `EQUALS` for an exact timestamp match.
`filters[]`	`key`	String	Yes	Uses the `createdTime` field.
`filters[]`	`values`	Array<Long>	Yes	Exact epoch timestamp in milliseconds.

Example response

{
  "data": {
    "results": []
  },
  "errors": []
}

An empty results array indicates that no surveys matched the supplied filter criteria.

Response parameters for this example

Parameter	Sub-parameter	Type	Description
`data`	-	Object	Contains the survey search response.
`data`	`results`	Array<Object>	Contains surveys matching the request. Returns an empty array when no records match.
`results[]`	`id`	String	Unique identifier of the survey.
`results[]`	`name`	String	Name of the survey.
`results[]`	`parentProgramId`	String	Unique identifier of the parent program.
`results[]`	`parentProgramName`	String	Name of the parent program.
`results[]`	`status`	String	Current survey status, when returned.
`results[]`	`ownerUserId`	Long	Unique identifier of the survey owner.
`results[]`	`createdTime`	String	Date and time when the survey was created.
`results[]`	`modifiedTime`	String	Date and time when the survey was last modified.
`results[]`	`modifiedBy`	Long	Identifier of the user who last modified the survey.
`results[]`	`baseLanguage`	String	Base language configured for the survey.
`results[]`	`parentHierarchyIds`	Array<String>	Hierarchy IDs associated with the survey.
`results[]`	`surveyLanguages`	Array<String>	Additional language codes configured for the survey.
`errors`	-	Array<Object>	Contains error details. Returns an empty array when no errors are reported.

5.11 Paginate active surveys

Returns one active survey, starting from the first available result.

{
  "page": {
    "size": 1,
    "start": 0
  },
  "filter": {
    "type": "AND",
    "filters": [
      {
        "type": "EQUALS",
        "key": "status",
        "values": ["ACTIVE"]
      }
    ]
  }
}

Request parameters for this example

Parameter	Sub-parameter	Type	Required	Description
`page`	-	Object	No	Controls pagination for the search results.
`filter`	-	Object	Yes	Defines the search criteria used to retrieve surveys.
`filter`	`type`	String	Yes	Logical operator used to combine filter conditions. This example uses `AND`.
`filter`	`filters`	Array<Object>	Yes	List of filter conditions applied to the survey search.
`page`	`size`	Integer	No	Maximum number of records returned.
`page`	`start`	Integer	No	Zero-based starting index.
`filters[]`	`type`	String	Yes	Uses `EQUALS` for exact matching.
`filters[]`	`key`	String	Yes	Uses the `status` field.
`filters[]`	`values`	Array<String>	Yes	Status values to match, such as `ACTIVE`.

Example response

{
  "data": {
    "results": [
      {
        "id": "673c3e996e59f506defadd5a",
        "name": "mobile web count",
        "parentProgramId": "671b8ed98164750a00553356",
        "parentProgramName": "Testing DND",
        "status": "ACTIVE",
        "ownerUserId": 66011409,
        "createdTime": "Oct 30, 2025, 08:54:30 AM",
        "modifiedTime": "Sep 11, 2026, 01:31:47 PM",
        "modifiedBy": 66011409,
        "baseLanguage": "en",
        "parentHierarchyIds": [
          "671b8ed98164750a00553356"
        ],
        "surveyLanguages": [
          "hi"
        ]
      }
    ]
  },
  "errors": []
}

A populated results array contains the surveys that matched the request filters.

Response parameters for this example

Parameter	Sub-parameter	Type	Description
`data`	-	Object	Contains the survey search response.
`data`	`results`	Array<Object>	Contains surveys matching the request. Returns an empty array when no records match.
`results[]`	`id`	String	Unique identifier of the survey.
`results[]`	`name`	String	Name of the survey.
`results[]`	`parentProgramId`	String	Unique identifier of the parent program.
`results[]`	`parentProgramName`	String	Name of the parent program.
`results[]`	`status`	String	Current survey status, when returned.
`results[]`	`ownerUserId`	Long	Unique identifier of the survey owner.
`results[]`	`createdTime`	String	Date and time when the survey was created.
`results[]`	`modifiedTime`	String	Date and time when the survey was last modified.
`results[]`	`modifiedBy`	Long	Identifier of the user who last modified the survey.
`results[]`	`baseLanguage`	String	Base language configured for the survey.
`results[]`	`parentHierarchyIds`	Array<String>	Hierarchy IDs associated with the survey.
`results[]`	`surveyLanguages`	Array<String>	Additional language codes configured for the survey.
`errors`	-	Array<Object>	Contains error details. Returns an empty array when no errors are reported.

5.12 Apply multiple filters for status and owner

Retrieves active surveys owned by the specified user. Because the filter type is AND, a survey must satisfy both conditions.

{
  "filter": {
    "type": "AND",
    "filters": [
      {
        "type": "EQUALS",
        "key": "status",
        "values": ["ACTIVE"]
      },
      {
        "type": "EQUALS",
        "key": "ownerUserId",
        "values": ["66069496"]
      }
    ]
  }
}

Request parameters for this example

Parameter	Sub-parameter	Type	Required	Description
`filter`	-	Object	Yes	Defines the search criteria used to retrieve surveys.
`filter`	`type`	String	Yes	Logical operator used to combine filter conditions. This example uses `AND`.
`filter`	`filters`	Array<Object>	Yes	List of filter conditions applied to the survey search.
`filters[]`	`type`	String	Yes	Uses `EQUALS` for both conditions.
`filters[]`	`key`	String	Yes	Uses the `status` and `ownerUserId` fields.
`filters[]`	`values`	Array<String>	Yes	Values for the status and owner conditions.

Example response

{
  "data": {
    "results": []
  },
  "errors": []
}

An empty results array indicates that no surveys matched the supplied filter criteria.

Response parameters for this example

Parameter	Sub-parameter	Type	Description
`data`	-	Object	Contains the survey search response.
`data`	`results`	Array<Object>	Contains surveys matching the request. Returns an empty array when no records match.
`results[]`	`id`	String	Unique identifier of the survey.
`results[]`	`name`	String	Name of the survey.
`results[]`	`parentProgramId`	String	Unique identifier of the parent program.
`results[]`	`parentProgramName`	String	Name of the parent program.
`results[]`	`status`	String	Current survey status, when returned.
`results[]`	`ownerUserId`	Long	Unique identifier of the survey owner.
`results[]`	`createdTime`	String	Date and time when the survey was created.
`results[]`	`modifiedTime`	String	Date and time when the survey was last modified.
`results[]`	`modifiedBy`	Long	Identifier of the user who last modified the survey.
`results[]`	`baseLanguage`	String	Base language configured for the survey.
`results[]`	`parentHierarchyIds`	Array<String>	Hierarchy IDs associated with the survey.
`results[]`	`surveyLanguages`	Array<String>	Additional language codes configured for the survey.
`errors`	-	Array<Object>	Contains error details. Returns an empty array when no errors are reported.

6. Response format

6.1 Response parameters

Parameter	Sub-parameter	Type	Description
`data`	-	Object	Contains the survey records returned by the search request.
`data`	`results`	Array<Object>	List of surveys matching the search criteria. Returns an empty array when no matching surveys are found.
`errors`	-	Array<Object>	Contains error details when request processing fails. Returns an empty array when no errors are reported.

6.2 Survey object

Parameter	Type	Description
`id`	String	Unique identifier of the survey.
`name`	String	Name of the survey.
`parentProgramId`	String	Unique identifier of the parent program.
`parentProgramName`	String	Name of the parent program.
`status`	String	Current status of the survey, when available.
`ownerUserId`	Long	Unique identifier of the survey owner.
`createdTime`	String	Date and time when the survey was created.
`modifiedTime`	String	Date and time when the survey was last modified.
`modifiedBy`	Long	Unique identifier of the user who last modified the survey.
`baseLanguage`	String	Base language configured for the survey.
`parentHierarchyIds`	Array<String>	Hierarchy identifiers associated with the survey.
`surveyLanguages`	Array<String>	Additional language codes configured for the survey.

6.3 Example response with results

{
  "data": {
    "results": [
      {
        "id": "673c3e996e59f506defadd5a",
        "name": "mobile web count",
        "parentProgramId": "671b8ed98164750a00553356",
        "parentProgramName": "Testing DND",
        "status": "ACTIVE",
        "ownerUserId": 66011409,
        "createdTime": "Oct 30, 2025, 08:54:30 AM",
        "modifiedTime": "Sep 11, 2026, 01:31:47 PM",
        "modifiedBy": 66011409,
        "baseLanguage": "en",
        "parentHierarchyIds": [
          "671b8ed98164750a00553356"
        ],
        "surveyLanguages": [
          "hi"
        ]
      }
    ]
  },
  "errors": []
}

6.4 Example response with no matching results

{
  "data": {
    "results": []
  },
  "errors": []
}

An empty results array indicates that no surveys matched the supplied filters. An empty errors array indicates that the response does not contain an API error object.

7. Usage guidance

Use EQUALS for exact matches, such as survey status, owner ID, program hierarchy ID, or creation timestamp.
Use CONTAINS for partial text matching on a survey name.
Use GT to retrieve records created or modified after a timestamp.
Use LT to retrieve records created before a timestamp.
Combine filters with AND when every condition must be satisfied.
Use page.size and page.start to control the number and starting position of returned records.
Treat time-filter values as Unix epoch timestamps in milliseconds, as demonstrated in the source examples.

8. Quick reference

Item	Value
Method	`POST`
Production endpoint	`https://api3.sprinklr.com/{env}/api/v3/search/cfmSurvey`
Content type	`application/json`
Logical operator demonstrated	`AND`
Filter operators demonstrated	`EQUALS`, `CONTAINS`, `GT`, `LT`
Filter keys demonstrated	`parentHierarchyIds`, `status`, `name`, `ownerUserId`, `createdTime`, `modifiedTime`
Pagination fields	`page.size`, `page.start`
Response envelope	`data.results`, `errors`

CFM Survey Search API V3 Developer Guide

1. Overview

2. API endpoint

3. Authentication and headers

4. Request body

4.1 Request parameters

4.2 Supported filters demonstrated in this guide

5. Search examples

5.1 Filter by program and status

Request parameters for this example

Example response

Response parameters for this example

5.2 Filter by status

Request parameters for this example

Example response

Response parameters for this example

5.3 Filter by creation time using LT

Request parameters for this example

Example response

Response parameters for this example

5.4 Filter by survey name

Request parameters for this example

Example response

Response parameters for this example

5.5 Filter by program hierarchy

Request parameters for this example

Example response

Response parameters for this example

5.6 Filter by modification time

Request parameters for this example

Example response

Response parameters for this example

5.7 Retrieve accessible surveys without field-level filters

Request parameters for this example

Example response

Response parameters for this example

5.8 Filter by survey owner

Request parameters for this example

Example response

Response parameters for this example

5.9 Filter by creation time using GT

Request parameters for this example

Example response

Response parameters for this example

5.10 Filter by exact creation time

Request parameters for this example

Example response

Response parameters for this example

5.11 Paginate active surveys

Request parameters for this example

Example response

Response parameters for this example

5.12 Apply multiple filters for status and owner

Request parameters for this example

Example response

Response parameters for this example

6. Response format

6.1 Response parameters

6.2 Survey object

6.3 Example response with results

6.4 Example response with no matching results

7. Usage guidance

8. Quick reference

Was this helpful?

5.3 Filter by creation time using `LT`

5.9 Filter by creation time using `GT`