Applies to: Sprinklr CFM Survey API V3 (/api/v3/search/cfmSurvey)
V2 API reference: CFM Survey | Sprinklr Developer Portal
The CFM Survey Search API retrieves surveys and supports filtering by status, survey or program identifiers, name, owner, creation time, and modification time. It also supports combining conditions and paginating results.
Security: Replace
{{accessToken}}with a valid OAuth access token. Do not publish access tokens, session cookies, or environment-specific credentials in documentation or source control.
All API calls are sent to the production endpoint:
https://api3.sprinklr.com/{env}/api/v3The examples in the source documents use the following QA endpoint:
https://qa6-api2-v3.sprinklr.com/api/v3/search/cfmSurveyFor customer-facing documentation, replace the QA host with the base URL and environment assigned to the customer.
| Header | Value | Required | Purpose |
|---|---|---|---|
Authorization | Bearer {{accessToken}} | Yes | Authenticates the API request. |
Content-Type | application/json | Yes | Identifies the request body as JSON. |
Accept | application/json | Recommended | Requests a JSON response. |
A successful request returns a data object and an errors array. When no surveys match the criteria, data.results is empty while errors can remain empty.
Returns accessible surveys without applying a field-level filter.
POST /api/v3/search/cfmSurvey
curl --location 'https://qa6-api2-v3.sprinklr.com/api/v3/search/cfmSurvey' \
--header 'Authorization: Bearer {{accessToken}}' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"filter": {
"type": "AND",
"filters": []
}
}'| Parameter | Sub-parameter | Required | Type | Description |
|---|---|---|---|---|
filter | Yes | Object | Defines the criteria used to search for CFM surveys. | |
filter | type | Yes | String | Logical operator used to combine conditions. The examples use AND. |
filter | filters | Yes | Array of objects | Individual filter conditions. Use an empty array to apply no field-level filters. |
filter.filters[] | type | Conditional | String | Comparison operator, such as EQUALS, CONTAINS, GT, or LT. Required when a condition is supplied. |
filter.filters[] | key | Conditional | String | Survey field evaluated by the condition, such as status, id, parentHierarchyIds, name, ownerUserId, createdTime, or modifiedTime. |
filter.filters[] | values | Conditional | Array | One or more values evaluated against the selected field. |
{
"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": []
}| Parameter | Sub-parameter | Type | Description |
|---|---|---|---|
data | Object | Contains the response payload. | |
data | results | Array of objects | Surveys matching the request. An empty array means no matching records were returned. |
data.results[] | id | String | Unique survey identifier. |
data.results[] | name | String | Survey name. |
data.results[] | parentProgramId | String | Unique identifier of the parent program. |
data.results[] | parentProgramName | String | Name of the parent program. |
data.results[] | status | String | Survey status, such as ACTIVE. The field can be absent in some returned records. |
data.results[] | ownerUserId | Integer | Unique identifier of the survey owner. |
data.results[] | createdTime | String | Date and time when the survey was created. |
data.results[] | modifiedTime | String | Date and time when the survey was last modified. |
data.results[] | modifiedBy | Integer | Unique identifier of the user who last modified the survey. |
data.results[] | baseLanguage | String | Base language of the survey, such as en. |
data.results[] | parentHierarchyIds | Array of strings | Parent hierarchy identifiers associated with the survey. |
data.results[] | surveyLanguages | Array of strings | Additional configured survey languages. |
errors | Array | Error information. An empty array means no error was returned. |
Returns surveys whose status exactly matches ACTIVE.
POST /api/v3/search/cfmSurvey
curl --location 'https://qa6-api2-v3.sprinklr.com/api/v3/search/cfmSurvey' \
--header 'Authorization: Bearer {{accessToken}}' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"filter": {
"type": "AND",
"filters": [
{
"type": "EQUALS",
"key": "status",
"values": [
"ACTIVE"
]
}
]
}
}'| Parameter | Sub-parameter | Required | Type | Description |
|---|---|---|---|---|
filter | Yes | Object | Defines the criteria used to search for CFM surveys. | |
filter | type | Yes | String | Logical operator used to combine conditions. The examples use AND. |
filter | filters | Yes | Array of objects | Individual filter conditions. Use an empty array to apply no field-level filters. |
filter.filters[] | type | Conditional | String | Comparison operator, such as EQUALS, CONTAINS, GT, or LT. Required when a condition is supplied. |
filter.filters[] | key | Conditional | String | Survey field evaluated by the condition, such as status, id, parentHierarchyIds, name, ownerUserId, createdTime, or modifiedTime. |
filter.filters[] | values | Conditional | Array | One or more values evaluated against the selected field. |
{
"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": []
}| Parameter | Sub-parameter | Type | Description |
|---|---|---|---|
data | Object | Contains the response payload. | |
data | results | Array of objects | Surveys matching the request. An empty array means no matching records were returned. |
data.results[] | id | String | Unique survey identifier. |
data.results[] | name | String | Survey name. |
data.results[] | parentProgramId | String | Unique identifier of the parent program. |
data.results[] | parentProgramName | String | Name of the parent program. |
data.results[] | status | String | Survey status, such as ACTIVE. The field can be absent in some returned records. |
data.results[] | ownerUserId | Integer | Unique identifier of the survey owner. |
data.results[] | createdTime | String | Date and time when the survey was created. |
data.results[] | modifiedTime | String | Date and time when the survey was last modified. |
data.results[] | modifiedBy | Integer | Unique identifier of the user who last modified the survey. |
data.results[] | baseLanguage | String | Base language of the survey, such as en. |
data.results[] | parentHierarchyIds | Array of strings | Parent hierarchy identifiers associated with the survey. |
data.results[] | surveyLanguages | Array of strings | Additional configured survey languages. |
errors | Array | Error information. An empty array means no error was returned. |
Returns surveys whose status exactly matches DRAFT.
POST /api/v3/search/cfmSurvey
curl --location 'https://qa6-api2-v3.sprinklr.com/api/v3/search/cfmSurvey' \
--header 'Authorization: Bearer {{accessToken}}' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"filter": {
"type": "AND",
"filters": [
{
"type": "EQUALS",
"key": "status",
"values": [
"DRAFT"
]
}
]
}
}'| Parameter | Sub-parameter | Required | Type | Description |
|---|---|---|---|---|
filter | Yes | Object | Defines the criteria used to search for CFM surveys. | |
filter | type | Yes | String | Logical operator used to combine conditions. The examples use AND. |
filter | filters | Yes | Array of objects | Individual filter conditions. Use an empty array to apply no field-level filters. |
filter.filters[] | type | Conditional | String | Comparison operator, such as EQUALS, CONTAINS, GT, or LT. Required when a condition is supplied. |
filter.filters[] | key | Conditional | String | Survey field evaluated by the condition, such as status, id, parentHierarchyIds, name, ownerUserId, createdTime, or modifiedTime. |
filter.filters[] | values | Conditional | Array | One or more values evaluated against the selected field. |
{
"data": {
"results": [
{
"id": "673c3e996e59f506defadd5a",
"name": "mobile web count",
"parentProgramId": "671b8ed98164750a00553356",
"parentProgramName": "Testing DND",
"status": "DRAFT",
"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": []
}| Parameter | Sub-parameter | Type | Description |
|---|---|---|---|
data | Object | Contains the response payload. | |
data | results | Array of objects | Surveys matching the request. An empty array means no matching records were returned. |
data.results[] | id | String | Unique survey identifier. |
data.results[] | name | String | Survey name. |
data.results[] | parentProgramId | String | Unique identifier of the parent program. |
data.results[] | parentProgramName | String | Name of the parent program. |
data.results[] | status | String | Survey status, such as ACTIVE. The field can be absent in some returned records. |
data.results[] | ownerUserId | Integer | Unique identifier of the survey owner. |
data.results[] | createdTime | String | Date and time when the survey was created. |
data.results[] | modifiedTime | String | Date and time when the survey was last modified. |
data.results[] | modifiedBy | Integer | Unique identifier of the user who last modified the survey. |
data.results[] | baseLanguage | String | Base language of the survey, such as en. |
data.results[] | parentHierarchyIds | Array of strings | Parent hierarchy identifiers associated with the survey. |
data.results[] | surveyLanguages | Array of strings | Additional configured survey languages. |
errors | Array | Error information. An empty array means no error was returned. |
Introduces the common endpoint, authentication headers, request envelope, and response envelope used by the examples in this guide.
POST /api/v3/search/cfmSurvey
curl --location 'https://qa6-api2-v3.sprinklr.com/api/v3/search/cfmSurvey' \
--header 'Authorization: Bearer {{accessToken}}' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"filter": {
"type": "AND",
"filters": []
}
}'| Parameter | Sub-parameter | Required | Type | Description |
|---|---|---|---|---|
filter | Yes | Object | Defines the criteria used to search for CFM surveys. | |
filter | type | Yes | String | Logical operator used to combine conditions. The examples use AND. |
filter | filters | Yes | Array of objects | Individual filter conditions. Use an empty array to apply no field-level filters. |
filter.filters[] | type | Conditional | String | Comparison operator, such as EQUALS, CONTAINS, GT, or LT. Required when a condition is supplied. |
filter.filters[] | key | Conditional | String | Survey field evaluated by the condition, such as status, id, parentHierarchyIds, name, ownerUserId, createdTime, or modifiedTime. |
filter.filters[] | values | Conditional | Array | One or more values evaluated against the selected field. |
{
"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": []
}| Parameter | Sub-parameter | Type | Description |
|---|---|---|---|
data | Object | Contains the response payload. | |
data | results | Array of objects | Surveys matching the request. An empty array means no matching records were returned. |
data.results[] | id | String | Unique survey identifier. |
data.results[] | name | String | Survey name. |
data.results[] | parentProgramId | String | Unique identifier of the parent program. |
data.results[] | parentProgramName | String | Name of the parent program. |
data.results[] | status | String | Survey status, such as ACTIVE. The field can be absent in some returned records. |
data.results[] | ownerUserId | Integer | Unique identifier of the survey owner. |
data.results[] | createdTime | String | Date and time when the survey was created. |
data.results[] | modifiedTime | String | Date and time when the survey was last modified. |
data.results[] | modifiedBy | Integer | Unique identifier of the user who last modified the survey. |
data.results[] | baseLanguage | String | Base language of the survey, such as en. |
data.results[] | parentHierarchyIds | Array of strings | Parent hierarchy identifiers associated with the survey. |
data.results[] | surveyLanguages | Array of strings | Additional configured survey languages. |
errors | Array | Error information. An empty array means no error was returned. |
Returns surveys associated with the specified program hierarchy identifier.
POST /api/v3/search/cfmSurvey
curl --location 'https://qa6-api2-v3.sprinklr.com/api/v3/search/cfmSurvey' \
--header 'Authorization: Bearer {{accessToken}}' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"filter": {
"type": "AND",
"filters": [
{
"type": "EQUALS",
"key": "parentHierarchyIds",
"values": [
"6a79a1637bac8dce7930723d"
]
}
]
}
}'| Parameter | Sub-parameter | Required | Type | Description |
|---|---|---|---|---|
filter | Yes | Object | Defines the criteria used to search for CFM surveys. | |
filter | type | Yes | String | Logical operator used to combine conditions. The examples use AND. |
filter | filters | Yes | Array of objects | Individual filter conditions. Use an empty array to apply no field-level filters. |
filter.filters[] | type | Conditional | String | Comparison operator, such as EQUALS, CONTAINS, GT, or LT. Required when a condition is supplied. |
filter.filters[] | key | Conditional | String | Survey field evaluated by the condition, such as status, id, parentHierarchyIds, name, ownerUserId, createdTime, or modifiedTime. |
filter.filters[] | values | Conditional | Array | One or more values evaluated against the selected field. |
{
"data": {
"results": []
},
"errors": []
}| Parameter | Sub-parameter | Type | Description |
|---|---|---|---|
data | Object | Contains the response payload. | |
data | results | Array of objects | Surveys matching the request. An empty array means no matching records were returned. |
data.results[] | id | String | Unique survey identifier. |
data.results[] | name | String | Survey name. |
data.results[] | parentProgramId | String | Unique identifier of the parent program. |
data.results[] | parentProgramName | String | Name of the parent program. |
data.results[] | status | String | Survey status, such as ACTIVE. The field can be absent in some returned records. |
data.results[] | ownerUserId | Integer | Unique identifier of the survey owner. |
data.results[] | createdTime | String | Date and time when the survey was created. |
data.results[] | modifiedTime | String | Date and time when the survey was last modified. |
data.results[] | modifiedBy | Integer | Unique identifier of the user who last modified the survey. |
data.results[] | baseLanguage | String | Base language of the survey, such as en. |
data.results[] | parentHierarchyIds | Array of strings | Parent hierarchy identifiers associated with the survey. |
data.results[] | surveyLanguages | Array of strings | Additional configured survey languages. |
errors | Array | Error information. An empty array means no error was returned. |
Returns the survey whose unique identifier exactly matches the supplied value.
POST /api/v3/search/cfmSurvey
curl --location 'https://qa6-api2-v3.sprinklr.com/api/v3/search/cfmSurvey' \
--header 'Authorization: Bearer {{accessToken}}' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"filter": {
"type": "AND",
"filters": [
{
"type": "EQUALS",
"key": "id",
"values": [
"6a7982ece10415480020f15d"
]
}
]
}
}'| Parameter | Sub-parameter | Required | Type | Description |
|---|---|---|---|---|
filter | Yes | Object | Defines the criteria used to search for CFM surveys. | |
filter | type | Yes | String | Logical operator used to combine conditions. The examples use AND. |
filter | filters | Yes | Array of objects | Individual filter conditions. Use an empty array to apply no field-level filters. |
filter.filters[] | type | Conditional | String | Comparison operator, such as EQUALS, CONTAINS, GT, or LT. Required when a condition is supplied. |
filter.filters[] | key | Conditional | String | Survey field evaluated by the condition, such as status, id, parentHierarchyIds, name, ownerUserId, createdTime, or modifiedTime. |
filter.filters[] | values | Conditional | Array | One or more values evaluated against the selected field. |
{
"data": {
"results": []
},
"errors": []
}| Parameter | Sub-parameter | Type | Description |
|---|---|---|---|
data | Object | Contains the response payload. | |
data | results | Array of objects | Surveys matching the request. An empty array means no matching records were returned. |
data.results[] | id | String | Unique survey identifier. |
data.results[] | name | String | Survey name. |
data.results[] | parentProgramId | String | Unique identifier of the parent program. |
data.results[] | parentProgramName | String | Name of the parent program. |
data.results[] | status | String | Survey status, such as ACTIVE. The field can be absent in some returned records. |
data.results[] | ownerUserId | Integer | Unique identifier of the survey owner. |
data.results[] | createdTime | String | Date and time when the survey was created. |
data.results[] | modifiedTime | String | Date and time when the survey was last modified. |
data.results[] | modifiedBy | Integer | Unique identifier of the user who last modified the survey. |
data.results[] | baseLanguage | String | Base language of the survey, such as en. |
data.results[] | parentHierarchyIds | Array of strings | Parent hierarchy identifiers associated with the survey. |
data.results[] | surveyLanguages | Array of strings | Additional configured survey languages. |
errors | Array | Error information. An empty array means no error was returned. |
Returns surveys that satisfy both the program hierarchy and ACTIVE status conditions.
POST /api/v3/search/cfmSurvey
curl --location 'https://qa6-api2-v3.sprinklr.com/api/v3/search/cfmSurvey' \
--header 'Authorization: Bearer {{accessToken}}' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"filter": {
"type": "AND",
"filters": [
{
"type": "EQUALS",
"key": "parentHierarchyIds",
"values": [
"6a79a1637bac8dce7930723d"
]
},
{
"type": "EQUALS",
"key": "status",
"values": [
"ACTIVE"
]
}
]
}
}'| Parameter | Sub-parameter | Required | Type | Description |
|---|---|---|---|---|
filter | Yes | Object | Defines the criteria used to search for CFM surveys. | |
filter | type | Yes | String | Logical operator used to combine conditions. The examples use AND. |
filter | filters | Yes | Array of objects | Individual filter conditions. Use an empty array to apply no field-level filters. |
filter.filters[] | type | Conditional | String | Comparison operator, such as EQUALS, CONTAINS, GT, or LT. Required when a condition is supplied. |
filter.filters[] | key | Conditional | String | Survey field evaluated by the condition, such as status, id, parentHierarchyIds, name, ownerUserId, createdTime, or modifiedTime. |
filter.filters[] | values | Conditional | Array | One or more values evaluated against the selected field. |
{
"data": {
"results": []
},
"errors": []
}| Parameter | Sub-parameter | Type | Description |
|---|---|---|---|
data | Object | Contains the response payload. | |
data | results | Array of objects | Surveys matching the request. An empty array means no matching records were returned. |
data.results[] | id | String | Unique survey identifier. |
data.results[] | name | String | Survey name. |
data.results[] | parentProgramId | String | Unique identifier of the parent program. |
data.results[] | parentProgramName | String | Name of the parent program. |
data.results[] | status | String | Survey status, such as ACTIVE. The field can be absent in some returned records. |
data.results[] | ownerUserId | Integer | Unique identifier of the survey owner. |
data.results[] | createdTime | String | Date and time when the survey was created. |
data.results[] | modifiedTime | String | Date and time when the survey was last modified. |
data.results[] | modifiedBy | Integer | Unique identifier of the user who last modified the survey. |
data.results[] | baseLanguage | String | Base language of the survey, such as en. |
data.results[] | parentHierarchyIds | Array of strings | Parent hierarchy identifiers associated with the survey. |
data.results[] | surveyLanguages | Array of strings | Additional configured survey languages. |
errors | Array | Error information. An empty array means no error was returned. |
Searches the survey name field for the supplied text by using CONTAINS.
POST /api/v3/search/cfmSurvey
curl --location 'https://qa6-api2-v3.sprinklr.com/api/v3/search/cfmSurvey' \
--header 'Authorization: Bearer {{accessToken}}' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"filter": {
"type": "AND",
"filters": [
{
"type": "CONTAINS",
"key": "name",
"values": [
"survey"
]
}
]
}
}'| Parameter | Sub-parameter | Required | Type | Description |
|---|---|---|---|---|
filter | Yes | Object | Defines the criteria used to search for CFM surveys. | |
filter | type | Yes | String | Logical operator used to combine conditions. The examples use AND. |
filter | filters | Yes | Array of objects | Individual filter conditions. Use an empty array to apply no field-level filters. |
filter.filters[] | type | Conditional | String | Comparison operator, such as EQUALS, CONTAINS, GT, or LT. Required when a condition is supplied. |
filter.filters[] | key | Conditional | String | Survey field evaluated by the condition, such as status, id, parentHierarchyIds, name, ownerUserId, createdTime, or modifiedTime. |
filter.filters[] | values | Conditional | Array | One or more values evaluated against the selected field. |
{
"data": {
"results": []
},
"errors": []
}| Parameter | Sub-parameter | Type | Description |
|---|---|---|---|
data | Object | Contains the response payload. | |
data | results | Array of objects | Surveys matching the request. An empty array means no matching records were returned. |
data.results[] | id | String | Unique survey identifier. |
data.results[] | name | String | Survey name. |
data.results[] | parentProgramId | String | Unique identifier of the parent program. |
data.results[] | parentProgramName | String | Name of the parent program. |
data.results[] | status | String | Survey status, such as ACTIVE. The field can be absent in some returned records. |
data.results[] | ownerUserId | Integer | Unique identifier of the survey owner. |
data.results[] | createdTime | String | Date and time when the survey was created. |
data.results[] | modifiedTime | String | Date and time when the survey was last modified. |
data.results[] | modifiedBy | Integer | Unique identifier of the user who last modified the survey. |
data.results[] | baseLanguage | String | Base language of the survey, such as en. |
data.results[] | parentHierarchyIds | Array of strings | Parent hierarchy identifiers associated with the survey. |
data.results[] | surveyLanguages | Array of strings | Additional configured survey languages. |
errors | Array | Error information. An empty array means no error was returned. |
The source example filters parentHierarchyIds; despite its original title, it does not send a program-name field.
POST /api/v3/search/cfmSurvey
curl --location 'https://qa6-api2-v3.sprinklr.com/api/v3/search/cfmSurvey' \
--header 'Authorization: Bearer {{accessToken}}' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"filter": {
"type": "AND",
"filters": [
{
"type": "EQUALS",
"key": "parentHierarchyIds",
"values": [
"6a79a1637bac8dce7930723d"
]
}
]
}
}'| Parameter | Sub-parameter | Required | Type | Description |
|---|---|---|---|---|
filter | Yes | Object | Defines the criteria used to search for CFM surveys. | |
filter | type | Yes | String | Logical operator used to combine conditions. The examples use AND. |
filter | filters | Yes | Array of objects | Individual filter conditions. Use an empty array to apply no field-level filters. |
filter.filters[] | type | Conditional | String | Comparison operator, such as EQUALS, CONTAINS, GT, or LT. Required when a condition is supplied. |
filter.filters[] | key | Conditional | String | Survey field evaluated by the condition, such as status, id, parentHierarchyIds, name, ownerUserId, createdTime, or modifiedTime. |
filter.filters[] | values | Conditional | Array | One or more values evaluated against the selected field. |
{
"data": {
"results": []
},
"errors": []
}| Parameter | Sub-parameter | Type | Description |
|---|---|---|---|
data | Object | Contains the response payload. | |
data | results | Array of objects | Surveys matching the request. An empty array means no matching records were returned. |
data.results[] | id | String | Unique survey identifier. |
data.results[] | name | String | Survey name. |
data.results[] | parentProgramId | String | Unique identifier of the parent program. |
data.results[] | parentProgramName | String | Name of the parent program. |
data.results[] | status | String | Survey status, such as ACTIVE. The field can be absent in some returned records. |
data.results[] | ownerUserId | Integer | Unique identifier of the survey owner. |
data.results[] | createdTime | String | Date and time when the survey was created. |
data.results[] | modifiedTime | String | Date and time when the survey was last modified. |
data.results[] | modifiedBy | Integer | Unique identifier of the user who last modified the survey. |
data.results[] | baseLanguage | String | Base language of the survey, such as en. |
data.results[] | parentHierarchyIds | Array of strings | Parent hierarchy identifiers associated with the survey. |
data.results[] | surveyLanguages | Array of strings | Additional configured survey languages. |
errors | Array | Error information. An empty array means no error was returned. |
Returns surveys whose ownerUserId exactly matches the supplied user ID.
POST /api/v3/search/cfmSurvey
curl --location 'https://qa6-api2-v3.sprinklr.com/api/v3/search/cfmSurvey' \
--header 'Authorization: Bearer {{accessToken}}' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"filter": {
"type": "AND",
"filters": [
{
"type": "EQUALS",
"key": "ownerUserId",
"values": [
"66069496"
]
}
]
}
}'| Parameter | Sub-parameter | Required | Type | Description |
|---|---|---|---|---|
filter | Yes | Object | Defines the criteria used to search for CFM surveys. | |
filter | type | Yes | String | Logical operator used to combine conditions. The examples use AND. |
filter | filters | Yes | Array of objects | Individual filter conditions. Use an empty array to apply no field-level filters. |
filter.filters[] | type | Conditional | String | Comparison operator, such as EQUALS, CONTAINS, GT, or LT. Required when a condition is supplied. |
filter.filters[] | key | Conditional | String | Survey field evaluated by the condition, such as status, id, parentHierarchyIds, name, ownerUserId, createdTime, or modifiedTime. |
filter.filters[] | values | Conditional | Array | One or more values evaluated against the selected field. |
{
"data": {
"results": []
},
"errors": []
}| Parameter | Sub-parameter | Type | Description |
|---|---|---|---|
data | Object | Contains the response payload. | |
data | results | Array of objects | Surveys matching the request. An empty array means no matching records were returned. |
data.results[] | id | String | Unique survey identifier. |
data.results[] | name | String | Survey name. |
data.results[] | parentProgramId | String | Unique identifier of the parent program. |
data.results[] | parentProgramName | String | Name of the parent program. |
data.results[] | status | String | Survey status, such as ACTIVE. The field can be absent in some returned records. |
data.results[] | ownerUserId | Integer | Unique identifier of the survey owner. |
data.results[] | createdTime | String | Date and time when the survey was created. |
data.results[] | modifiedTime | String | Date and time when the survey was last modified. |
data.results[] | modifiedBy | Integer | Unique identifier of the user who last modified the survey. |
data.results[] | baseLanguage | String | Base language of the survey, such as en. |
data.results[] | parentHierarchyIds | Array of strings | Parent hierarchy identifiers associated with the survey. |
data.results[] | surveyLanguages | Array of strings | Additional configured survey languages. |
errors | Array | Error information. An empty array means no error was returned. |
Uses GT on createdTime to return surveys created after the supplied epoch-millisecond value.
POST /api/v3/search/cfmSurvey
curl --location 'https://qa6-api2-v3.sprinklr.com/api/v3/search/cfmSurvey' \
--header 'Authorization: Bearer {{accessToken}}' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"filter": {
"type": "AND",
"filters": [
{
"type": "GT",
"key": "createdTime",
"values": [
1787553659989
]
}
]
}
}'| Parameter | Sub-parameter | Required | Type | Description |
|---|---|---|---|---|
filter | Yes | Object | Defines the criteria used to search for CFM surveys. | |
filter | type | Yes | String | Logical operator used to combine conditions. The examples use AND. |
filter | filters | Yes | Array of objects | Individual filter conditions. Use an empty array to apply no field-level filters. |
filter.filters[] | type | Conditional | String | Comparison operator, such as EQUALS, CONTAINS, GT, or LT. Required when a condition is supplied. |
filter.filters[] | key | Conditional | String | Survey field evaluated by the condition, such as status, id, parentHierarchyIds, name, ownerUserId, createdTime, or modifiedTime. |
filter.filters[] | values | Conditional | Array | One or more values evaluated against the selected field. |
{
"data": {
"results": []
},
"errors": []
}| Parameter | Sub-parameter | Type | Description |
|---|---|---|---|
data | Object | Contains the response payload. | |
data | results | Array of objects | Surveys matching the request. An empty array means no matching records were returned. |
data.results[] | id | String | Unique survey identifier. |
data.results[] | name | String | Survey name. |
data.results[] | parentProgramId | String | Unique identifier of the parent program. |
data.results[] | parentProgramName | String | Name of the parent program. |
data.results[] | status | String | Survey status, such as ACTIVE. The field can be absent in some returned records. |
data.results[] | ownerUserId | Integer | Unique identifier of the survey owner. |
data.results[] | createdTime | String | Date and time when the survey was created. |
data.results[] | modifiedTime | String | Date and time when the survey was last modified. |
data.results[] | modifiedBy | Integer | Unique identifier of the user who last modified the survey. |
data.results[] | baseLanguage | String | Base language of the survey, such as en. |
data.results[] | parentHierarchyIds | Array of strings | Parent hierarchy identifiers associated with the survey. |
data.results[] | surveyLanguages | Array of strings | Additional configured survey languages. |
errors | Array | Error information. An empty array means no error was returned. |
Uses LT on createdTime to return surveys created before the supplied epoch-millisecond value.
POST /api/v3/search/cfmSurvey
curl --location 'https://qa6-api2-v3.sprinklr.com/api/v3/search/cfmSurvey' \
--header 'Authorization: Bearer {{accessToken}}' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"filter": {
"type": "AND",
"filters": [
{
"type": "LT",
"key": "createdTime",
"values": [
1787553659989
]
}
]
}
}'| Parameter | Sub-parameter | Required | Type | Description |
|---|---|---|---|---|
filter | Yes | Object | Defines the criteria used to search for CFM surveys. | |
filter | type | Yes | String | Logical operator used to combine conditions. The examples use AND. |
filter | filters | Yes | Array of objects | Individual filter conditions. Use an empty array to apply no field-level filters. |
filter.filters[] | type | Conditional | String | Comparison operator, such as EQUALS, CONTAINS, GT, or LT. Required when a condition is supplied. |
filter.filters[] | key | Conditional | String | Survey field evaluated by the condition, such as status, id, parentHierarchyIds, name, ownerUserId, createdTime, or modifiedTime. |
filter.filters[] | values | Conditional | Array | One or more values evaluated against the selected field. |
{
"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": []
}| Parameter | Sub-parameter | Type | Description |
|---|---|---|---|
data | Object | Contains the response payload. | |
data | results | Array of objects | Surveys matching the request. An empty array means no matching records were returned. |
data.results[] | id | String | Unique survey identifier. |
data.results[] | name | String | Survey name. |
data.results[] | parentProgramId | String | Unique identifier of the parent program. |
data.results[] | parentProgramName | String | Name of the parent program. |
data.results[] | status | String | Survey status, such as ACTIVE. The field can be absent in some returned records. |
data.results[] | ownerUserId | Integer | Unique identifier of the survey owner. |
data.results[] | createdTime | String | Date and time when the survey was created. |
data.results[] | modifiedTime | String | Date and time when the survey was last modified. |
data.results[] | modifiedBy | Integer | Unique identifier of the user who last modified the survey. |
data.results[] | baseLanguage | String | Base language of the survey, such as en. |
data.results[] | parentHierarchyIds | Array of strings | Parent hierarchy identifiers associated with the survey. |
data.results[] | surveyLanguages | Array of strings | Additional configured survey languages. |
errors | Array | Error information. An empty array means no error was returned. |
Returns surveys whose createdTime exactly matches the supplied epoch-millisecond value.
POST /api/v3/search/cfmSurvey
curl --location 'https://qa6-api2-v3.sprinklr.com/api/v3/search/cfmSurvey' \
--header 'Authorization: Bearer {{accessToken}}' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"filter": {
"type": "AND",
"filters": [
{
"type": "EQUALS",
"key": "createdTime",
"values": [
1787554226496
]
}
]
}
}'| Parameter | Sub-parameter | Required | Type | Description |
|---|---|---|---|---|
filter | Yes | Object | Defines the criteria used to search for CFM surveys. | |
filter | type | Yes | String | Logical operator used to combine conditions. The examples use AND. |
filter | filters | Yes | Array of objects | Individual filter conditions. Use an empty array to apply no field-level filters. |
filter.filters[] | type | Conditional | String | Comparison operator, such as EQUALS, CONTAINS, GT, or LT. Required when a condition is supplied. |
filter.filters[] | key | Conditional | String | Survey field evaluated by the condition, such as status, id, parentHierarchyIds, name, ownerUserId, createdTime, or modifiedTime. |
filter.filters[] | values | Conditional | Array | One or more values evaluated against the selected field. |
{
"data": {
"results": []
},
"errors": []
}| Parameter | Sub-parameter | Type | Description |
|---|---|---|---|
data | Object | Contains the response payload. | |
data | results | Array of objects | Surveys matching the request. An empty array means no matching records were returned. |
data.results[] | id | String | Unique survey identifier. |
data.results[] | name | String | Survey name. |
data.results[] | parentProgramId | String | Unique identifier of the parent program. |
data.results[] | parentProgramName | String | Name of the parent program. |
data.results[] | status | String | Survey status, such as ACTIVE. The field can be absent in some returned records. |
data.results[] | ownerUserId | Integer | Unique identifier of the survey owner. |
data.results[] | createdTime | String | Date and time when the survey was created. |
data.results[] | modifiedTime | String | Date and time when the survey was last modified. |
data.results[] | modifiedBy | Integer | Unique identifier of the user who last modified the survey. |
data.results[] | baseLanguage | String | Base language of the survey, such as en. |
data.results[] | parentHierarchyIds | Array of strings | Parent hierarchy identifiers associated with the survey. |
data.results[] | surveyLanguages | Array of strings | Additional configured survey languages. |
errors | Array | Error information. An empty array means no error was returned. |
Uses GT on modifiedTime to return surveys updated after the supplied epoch-millisecond value.
POST /api/v3/search/cfmSurvey
curl --location 'https://qa6-api2-v3.sprinklr.com/api/v3/search/cfmSurvey' \
--header 'Authorization: Bearer {{accessToken}}' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"filter": {
"type": "AND",
"filters": [
{
"type": "GT",
"key": "modifiedTime",
"values": [
"1735669800000"
]
}
]
}
}'| Parameter | Sub-parameter | Required | Type | Description |
|---|---|---|---|---|
filter | Yes | Object | Defines the criteria used to search for CFM surveys. | |
filter | type | Yes | String | Logical operator used to combine conditions. The examples use AND. |
filter | filters | Yes | Array of objects | Individual filter conditions. Use an empty array to apply no field-level filters. |
filter.filters[] | type | Conditional | String | Comparison operator, such as EQUALS, CONTAINS, GT, or LT. Required when a condition is supplied. |
filter.filters[] | key | Conditional | String | Survey field evaluated by the condition, such as status, id, parentHierarchyIds, name, ownerUserId, createdTime, or modifiedTime. |
filter.filters[] | values | Conditional | Array | One or more values evaluated against the selected field. |
{
"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": []
}| Parameter | Sub-parameter | Type | Description |
|---|---|---|---|
data | Object | Contains the response payload. | |
data | results | Array of objects | Surveys matching the request. An empty array means no matching records were returned. |
data.results[] | id | String | Unique survey identifier. |
data.results[] | name | String | Survey name. |
data.results[] | parentProgramId | String | Unique identifier of the parent program. |
data.results[] | parentProgramName | String | Name of the parent program. |
data.results[] | status | String | Survey status, such as ACTIVE. The field can be absent in some returned records. |
data.results[] | ownerUserId | Integer | Unique identifier of the survey owner. |
data.results[] | createdTime | String | Date and time when the survey was created. |
data.results[] | modifiedTime | String | Date and time when the survey was last modified. |
data.results[] | modifiedBy | Integer | Unique identifier of the user who last modified the survey. |
data.results[] | baseLanguage | String | Base language of the survey, such as en. |
data.results[] | parentHierarchyIds | Array of strings | Parent hierarchy identifiers associated with the survey. |
data.results[] | surveyLanguages | Array of strings | Additional configured survey languages. |
errors | Array | Error information. An empty array means no error was returned. |
Returns surveys that have ACTIVE status and are owned by the specified user.
POST /api/v3/search/cfmSurvey
curl --location 'https://qa6-api2-v3.sprinklr.com/api/v3/search/cfmSurvey' \
--header 'Authorization: Bearer {{accessToken}}' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"filter": {
"type": "AND",
"filters": [
{
"type": "EQUALS",
"key": "status",
"values": [
"ACTIVE"
]
},
{
"type": "EQUALS",
"key": "ownerUserId",
"values": [
"66069496"
]
}
]
}
}'| Parameter | Sub-parameter | Required | Type | Description |
|---|---|---|---|---|
filter | Yes | Object | Defines the criteria used to search for CFM surveys. | |
filter | type | Yes | String | Logical operator used to combine conditions. The examples use AND. |
filter | filters | Yes | Array of objects | Individual filter conditions. Use an empty array to apply no field-level filters. |
filter.filters[] | type | Conditional | String | Comparison operator, such as EQUALS, CONTAINS, GT, or LT. Required when a condition is supplied. |
filter.filters[] | key | Conditional | String | Survey field evaluated by the condition, such as status, id, parentHierarchyIds, name, ownerUserId, createdTime, or modifiedTime. |
filter.filters[] | values | Conditional | Array | One or more values evaluated against the selected field. |
{
"data": {
"results": []
},
"errors": []
}| Parameter | Sub-parameter | Type | Description |
|---|---|---|---|
data | Object | Contains the response payload. | |
data | results | Array of objects | Surveys matching the request. An empty array means no matching records were returned. |
data.results[] | id | String | Unique survey identifier. |
data.results[] | name | String | Survey name. |
data.results[] | parentProgramId | String | Unique identifier of the parent program. |
data.results[] | parentProgramName | String | Name of the parent program. |
data.results[] | status | String | Survey status, such as ACTIVE. The field can be absent in some returned records. |
data.results[] | ownerUserId | Integer | Unique identifier of the survey owner. |
data.results[] | createdTime | String | Date and time when the survey was created. |
data.results[] | modifiedTime | String | Date and time when the survey was last modified. |
data.results[] | modifiedBy | Integer | Unique identifier of the user who last modified the survey. |
data.results[] | baseLanguage | String | Base language of the survey, such as en. |
data.results[] | parentHierarchyIds | Array of strings | Parent hierarchy identifiers associated with the survey. |
data.results[] | surveyLanguages | Array of strings | Additional configured survey languages. |
errors | Array | Error information. An empty array means no error was returned. |
Limits the number of records returned and specifies the zero-based starting position.
POST /api/v3/search/cfmSurvey
curl --location 'https://qa6-api2-v3.sprinklr.com/api/v3/search/cfmSurvey' \
--header 'Authorization: Bearer {{accessToken}}' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"page": {
"size": 1,
"start": 0
},
"filter": {
"type": "AND",
"filters": [
{
"type": "EQUALS",
"key": "status",
"values": [
"ACTIVE"
]
}
]
}
}'| Parameter | Sub-parameter | Required | Type | Description |
|---|---|---|---|---|
page | No | Object | Controls pagination. | |
page | size | No | Integer | Maximum number of survey records returned. The example requests one record. |
page | start | No | Integer | Zero-based starting position. The example begins at the first record. |
filter | Yes | Object | Defines the survey filter criteria. | |
filter | type | Yes | String | Logical operator used to combine conditions. |
filter | filters | Yes | Array of objects | Individual filter conditions. |
filter.filters[] | type | Yes | String | Comparison operator. The example uses EQUALS. |
filter.filters[] | key | Yes | String | Field to filter. The example uses status. |
filter.filters[] | values | Yes | Array | Values evaluated against the selected field. |
{
"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": []
}| Parameter | Sub-parameter | Type | Description |
|---|---|---|---|
data | Object | Contains the response payload. | |
data | results | Array of objects | Surveys matching the request. An empty array means no matching records were returned. |
data.results[] | id | String | Unique survey identifier. |
data.results[] | name | String | Survey name. |
data.results[] | parentProgramId | String | Unique identifier of the parent program. |
data.results[] | parentProgramName | String | Name of the parent program. |
data.results[] | status | String | Survey status, such as ACTIVE. The field can be absent in some returned records. |
data.results[] | ownerUserId | Integer | Unique identifier of the survey owner. |
data.results[] | createdTime | String | Date and time when the survey was created. |
data.results[] | modifiedTime | String | Date and time when the survey was last modified. |
data.results[] | modifiedBy | Integer | Unique identifier of the user who last modified the survey. |
data.results[] | baseLanguage | String | Base language of the survey, such as en. |
data.results[] | parentHierarchyIds | Array of strings | Parent hierarchy identifiers associated with the survey. |
data.results[] | surveyLanguages | Array of strings | Additional configured survey languages. |
errors | Array | Error information. An empty array means no error was returned. |
A request with a missing, invalid, or expired access token can return HTTP 401 Unauthorized. The exact error identifier and message can vary by environment.
POST /api/v3/search/cfmSurvey
curl --location 'https://qa6-api2-v3.sprinklr.com/api/v3/search/cfmSurvey' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
"filter": {
"type": "AND",
"filters": []
}
}'| Parameter | Sub-parameter | Required | Type | Description |
|---|---|---|---|---|
filter | Yes | Object | Defines the criteria used to search for CFM surveys. | |
filter | type | Yes | String | Logical operator used to combine conditions. The examples use AND. |
filter | filters | Yes | Array of objects | Individual filter conditions. Use an empty array to apply no field-level filters. |
filter.filters[] | type | Conditional | String | Comparison operator, such as EQUALS, CONTAINS, GT, or LT. Required when a condition is supplied. |
filter.filters[] | key | Conditional | String | Survey field evaluated by the condition, such as status, id, parentHierarchyIds, name, ownerUserId, createdTime, or modifiedTime. |
filter.filters[] | values | Conditional | Array | One or more values evaluated against the selected field. |
{
"data": null,
"errors": [
{
"code": 401,
"message": "Unauthorized"
}
]
}| Parameter | Sub-parameter | Type | Description |
|---|---|---|---|
data | Object or null | Response data. It can be null when authentication fails. | |
errors | Array of objects | Contains authentication error details. | |
errors[] | code | Integer | HTTP or application error code. The example uses 401. |
errors[] | message | String | Human-readable error description. |
| Operator | Meaning | Example use |
|---|---|---|
EQUALS | Exact match | Status, survey ID, program hierarchy ID, owner ID, or exact creation time |
CONTAINS | Text contains a supplied value | Survey name |
GT | Greater than | Created or modified after an epoch-millisecond value |
LT | Less than | Created before an epoch-millisecond value |
- The original “Program Name” example filters
parentHierarchyIds, not a program-name field. Confirm the supported key with the API owner before presenting it as a program-name search. - An empty
resultsarray indicates that no records were returned for that request. It does not, by itself, prove that the field or operator is unsupported. - The source documents mix numeric and string representations of epoch values. Confirm the canonical request type with the API owner and use it consistently.
- The source unauthorized-request document contains an authenticated request and a successful data-shaped response. The
401example in this guide is a normalized documentation example and should be validated against an actual unauthorized response before publication.
Retrieve surveys accessible to the user and view survey details such as survey ID, name, status, parent program, owner, languages, and creation or modification information.
Search for surveys by attributes such as status, survey ID, program hierarchy ID, survey name, owner, creation time, or modification time.
Combine multiple conditions to retrieve a targeted set of surveys, such as active surveys belonging to a specific program or owned by a specific user.
Paginate survey search results by controlling the number of records returned and the starting position, making larger result sets easier to retrieve and process.