Skip to content

CFM Survey Search API V3 Developer Guide

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.

1. Base URL and environment

All API calls are sent to the production endpoint:

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

The examples in the source documents use the following QA endpoint:

https://qa6-api2-v3.sprinklr.com/api/v3/search/cfmSurvey

For customer-facing documentation, replace the QA host with the base URL and environment assigned to the customer.

2. Authentication and common headers

HeaderValueRequiredPurpose
AuthorizationBearer {{accessToken}}YesAuthenticates the API request.
Content-Typeapplication/jsonYesIdentifies the request body as JSON.
Acceptapplication/jsonRecommendedRequests a JSON response.

3. Common response behavior

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.

4. CFM Survey: List all surveys

Returns accessible surveys without applying a field-level filter.

Endpoint

POST /api/v3/search/cfmSurvey

Example request

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": []
  }
}'

Request parameters

ParameterSub-parameterRequiredTypeDescription
filterYesObjectDefines the criteria used to search for CFM surveys.
filtertypeYesStringLogical operator used to combine conditions. The examples use AND.
filterfiltersYesArray of objectsIndividual filter conditions. Use an empty array to apply no field-level filters.
filter.filters[]typeConditionalStringComparison operator, such as EQUALS, CONTAINS, GT, or LT. Required when a condition is supplied.
filter.filters[]keyConditionalStringSurvey field evaluated by the condition, such as status, id, parentHierarchyIds, name, ownerUserId, createdTime, or modifiedTime.
filter.filters[]valuesConditionalArrayOne or more values evaluated against the selected field.

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": []
}

Response parameters

ParameterSub-parameterTypeDescription
dataObjectContains the response payload.
dataresultsArray of objectsSurveys matching the request. An empty array means no matching records were returned.
data.results[]idStringUnique survey identifier.
data.results[]nameStringSurvey name.
data.results[]parentProgramIdStringUnique identifier of the parent program.
data.results[]parentProgramNameStringName of the parent program.
data.results[]statusStringSurvey status, such as ACTIVE. The field can be absent in some returned records.
data.results[]ownerUserIdIntegerUnique identifier of the survey owner.
data.results[]createdTimeStringDate and time when the survey was created.
data.results[]modifiedTimeStringDate and time when the survey was last modified.
data.results[]modifiedByIntegerUnique identifier of the user who last modified the survey.
data.results[]baseLanguageStringBase language of the survey, such as en.
data.results[]parentHierarchyIdsArray of stringsParent hierarchy identifiers associated with the survey.
data.results[]surveyLanguagesArray of stringsAdditional configured survey languages.
errorsArrayError information. An empty array means no error was returned.

5. CFM Survey: Filter by status: ACTIVE

Returns surveys whose status exactly matches ACTIVE.

Endpoint

POST /api/v3/search/cfmSurvey

Example request

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"
        ]
      }
    ]
  }
}'

Request parameters

ParameterSub-parameterRequiredTypeDescription
filterYesObjectDefines the criteria used to search for CFM surveys.
filtertypeYesStringLogical operator used to combine conditions. The examples use AND.
filterfiltersYesArray of objectsIndividual filter conditions. Use an empty array to apply no field-level filters.
filter.filters[]typeConditionalStringComparison operator, such as EQUALS, CONTAINS, GT, or LT. Required when a condition is supplied.
filter.filters[]keyConditionalStringSurvey field evaluated by the condition, such as status, id, parentHierarchyIds, name, ownerUserId, createdTime, or modifiedTime.
filter.filters[]valuesConditionalArrayOne or more values evaluated against the selected field.

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": []
}

Response parameters

ParameterSub-parameterTypeDescription
dataObjectContains the response payload.
dataresultsArray of objectsSurveys matching the request. An empty array means no matching records were returned.
data.results[]idStringUnique survey identifier.
data.results[]nameStringSurvey name.
data.results[]parentProgramIdStringUnique identifier of the parent program.
data.results[]parentProgramNameStringName of the parent program.
data.results[]statusStringSurvey status, such as ACTIVE. The field can be absent in some returned records.
data.results[]ownerUserIdIntegerUnique identifier of the survey owner.
data.results[]createdTimeStringDate and time when the survey was created.
data.results[]modifiedTimeStringDate and time when the survey was last modified.
data.results[]modifiedByIntegerUnique identifier of the user who last modified the survey.
data.results[]baseLanguageStringBase language of the survey, such as en.
data.results[]parentHierarchyIdsArray of stringsParent hierarchy identifiers associated with the survey.
data.results[]surveyLanguagesArray of stringsAdditional configured survey languages.
errorsArrayError information. An empty array means no error was returned.

6. CFM Survey: Filter by status: DRAFT

Returns surveys whose status exactly matches DRAFT.

Endpoint

POST /api/v3/search/cfmSurvey

Example request

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"
        ]
      }
    ]
  }
}'

Request parameters

ParameterSub-parameterRequiredTypeDescription
filterYesObjectDefines the criteria used to search for CFM surveys.
filtertypeYesStringLogical operator used to combine conditions. The examples use AND.
filterfiltersYesArray of objectsIndividual filter conditions. Use an empty array to apply no field-level filters.
filter.filters[]typeConditionalStringComparison operator, such as EQUALS, CONTAINS, GT, or LT. Required when a condition is supplied.
filter.filters[]keyConditionalStringSurvey field evaluated by the condition, such as status, id, parentHierarchyIds, name, ownerUserId, createdTime, or modifiedTime.
filter.filters[]valuesConditionalArrayOne or more values evaluated against the selected field.

Example response

{
  "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": []
}

Response parameters

ParameterSub-parameterTypeDescription
dataObjectContains the response payload.
dataresultsArray of objectsSurveys matching the request. An empty array means no matching records were returned.
data.results[]idStringUnique survey identifier.
data.results[]nameStringSurvey name.
data.results[]parentProgramIdStringUnique identifier of the parent program.
data.results[]parentProgramNameStringName of the parent program.
data.results[]statusStringSurvey status, such as ACTIVE. The field can be absent in some returned records.
data.results[]ownerUserIdIntegerUnique identifier of the survey owner.
data.results[]createdTimeStringDate and time when the survey was created.
data.results[]modifiedTimeStringDate and time when the survey was last modified.
data.results[]modifiedByIntegerUnique identifier of the user who last modified the survey.
data.results[]baseLanguageStringBase language of the survey, such as en.
data.results[]parentHierarchyIdsArray of stringsParent hierarchy identifiers associated with the survey.
data.results[]surveyLanguagesArray of stringsAdditional configured survey languages.
errorsArrayError information. An empty array means no error was returned.

7. CFM Survey: cfmSurvey endpoint

Introduces the common endpoint, authentication headers, request envelope, and response envelope used by the examples in this guide.

Endpoint

POST /api/v3/search/cfmSurvey

Example request

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": []
  }
}'

Request parameters

ParameterSub-parameterRequiredTypeDescription
filterYesObjectDefines the criteria used to search for CFM surveys.
filtertypeYesStringLogical operator used to combine conditions. The examples use AND.
filterfiltersYesArray of objectsIndividual filter conditions. Use an empty array to apply no field-level filters.
filter.filters[]typeConditionalStringComparison operator, such as EQUALS, CONTAINS, GT, or LT. Required when a condition is supplied.
filter.filters[]keyConditionalStringSurvey field evaluated by the condition, such as status, id, parentHierarchyIds, name, ownerUserId, createdTime, or modifiedTime.
filter.filters[]valuesConditionalArrayOne or more values evaluated against the selected field.

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": []
}

Response parameters

ParameterSub-parameterTypeDescription
dataObjectContains the response payload.
dataresultsArray of objectsSurveys matching the request. An empty array means no matching records were returned.
data.results[]idStringUnique survey identifier.
data.results[]nameStringSurvey name.
data.results[]parentProgramIdStringUnique identifier of the parent program.
data.results[]parentProgramNameStringName of the parent program.
data.results[]statusStringSurvey status, such as ACTIVE. The field can be absent in some returned records.
data.results[]ownerUserIdIntegerUnique identifier of the survey owner.
data.results[]createdTimeStringDate and time when the survey was created.
data.results[]modifiedTimeStringDate and time when the survey was last modified.
data.results[]modifiedByIntegerUnique identifier of the user who last modified the survey.
data.results[]baseLanguageStringBase language of the survey, such as en.
data.results[]parentHierarchyIdsArray of stringsParent hierarchy identifiers associated with the survey.
data.results[]surveyLanguagesArray of stringsAdditional configured survey languages.
errorsArrayError information. An empty array means no error was returned.

8. CFM Survey: Filter by Program ID

Returns surveys associated with the specified program hierarchy identifier.

Endpoint

POST /api/v3/search/cfmSurvey

Example request

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"
        ]
      }
    ]
  }
}'

Request parameters

ParameterSub-parameterRequiredTypeDescription
filterYesObjectDefines the criteria used to search for CFM surveys.
filtertypeYesStringLogical operator used to combine conditions. The examples use AND.
filterfiltersYesArray of objectsIndividual filter conditions. Use an empty array to apply no field-level filters.
filter.filters[]typeConditionalStringComparison operator, such as EQUALS, CONTAINS, GT, or LT. Required when a condition is supplied.
filter.filters[]keyConditionalStringSurvey field evaluated by the condition, such as status, id, parentHierarchyIds, name, ownerUserId, createdTime, or modifiedTime.
filter.filters[]valuesConditionalArrayOne or more values evaluated against the selected field.

Example response

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

Response parameters

ParameterSub-parameterTypeDescription
dataObjectContains the response payload.
dataresultsArray of objectsSurveys matching the request. An empty array means no matching records were returned.
data.results[]idStringUnique survey identifier.
data.results[]nameStringSurvey name.
data.results[]parentProgramIdStringUnique identifier of the parent program.
data.results[]parentProgramNameStringName of the parent program.
data.results[]statusStringSurvey status, such as ACTIVE. The field can be absent in some returned records.
data.results[]ownerUserIdIntegerUnique identifier of the survey owner.
data.results[]createdTimeStringDate and time when the survey was created.
data.results[]modifiedTimeStringDate and time when the survey was last modified.
data.results[]modifiedByIntegerUnique identifier of the user who last modified the survey.
data.results[]baseLanguageStringBase language of the survey, such as en.
data.results[]parentHierarchyIdsArray of stringsParent hierarchy identifiers associated with the survey.
data.results[]surveyLanguagesArray of stringsAdditional configured survey languages.
errorsArrayError information. An empty array means no error was returned.

9. CFM Survey: Filter by survey ID

Returns the survey whose unique identifier exactly matches the supplied value.

Endpoint

POST /api/v3/search/cfmSurvey

Example request

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"
        ]
      }
    ]
  }
}'

Request parameters

ParameterSub-parameterRequiredTypeDescription
filterYesObjectDefines the criteria used to search for CFM surveys.
filtertypeYesStringLogical operator used to combine conditions. The examples use AND.
filterfiltersYesArray of objectsIndividual filter conditions. Use an empty array to apply no field-level filters.
filter.filters[]typeConditionalStringComparison operator, such as EQUALS, CONTAINS, GT, or LT. Required when a condition is supplied.
filter.filters[]keyConditionalStringSurvey field evaluated by the condition, such as status, id, parentHierarchyIds, name, ownerUserId, createdTime, or modifiedTime.
filter.filters[]valuesConditionalArrayOne or more values evaluated against the selected field.

Example response

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

Response parameters

ParameterSub-parameterTypeDescription
dataObjectContains the response payload.
dataresultsArray of objectsSurveys matching the request. An empty array means no matching records were returned.
data.results[]idStringUnique survey identifier.
data.results[]nameStringSurvey name.
data.results[]parentProgramIdStringUnique identifier of the parent program.
data.results[]parentProgramNameStringName of the parent program.
data.results[]statusStringSurvey status, such as ACTIVE. The field can be absent in some returned records.
data.results[]ownerUserIdIntegerUnique identifier of the survey owner.
data.results[]createdTimeStringDate and time when the survey was created.
data.results[]modifiedTimeStringDate and time when the survey was last modified.
data.results[]modifiedByIntegerUnique identifier of the user who last modified the survey.
data.results[]baseLanguageStringBase language of the survey, such as en.
data.results[]parentHierarchyIdsArray of stringsParent hierarchy identifiers associated with the survey.
data.results[]surveyLanguagesArray of stringsAdditional configured survey languages.
errorsArrayError information. An empty array means no error was returned.

10. CFM Survey: Filter by program ID and ACTIVE status

Returns surveys that satisfy both the program hierarchy and ACTIVE status conditions.

Endpoint

POST /api/v3/search/cfmSurvey

Example request

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"
        ]
      }
    ]
  }
}'

Request parameters

ParameterSub-parameterRequiredTypeDescription
filterYesObjectDefines the criteria used to search for CFM surveys.
filtertypeYesStringLogical operator used to combine conditions. The examples use AND.
filterfiltersYesArray of objectsIndividual filter conditions. Use an empty array to apply no field-level filters.
filter.filters[]typeConditionalStringComparison operator, such as EQUALS, CONTAINS, GT, or LT. Required when a condition is supplied.
filter.filters[]keyConditionalStringSurvey field evaluated by the condition, such as status, id, parentHierarchyIds, name, ownerUserId, createdTime, or modifiedTime.
filter.filters[]valuesConditionalArrayOne or more values evaluated against the selected field.

Example response

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

Response parameters

ParameterSub-parameterTypeDescription
dataObjectContains the response payload.
dataresultsArray of objectsSurveys matching the request. An empty array means no matching records were returned.
data.results[]idStringUnique survey identifier.
data.results[]nameStringSurvey name.
data.results[]parentProgramIdStringUnique identifier of the parent program.
data.results[]parentProgramNameStringName of the parent program.
data.results[]statusStringSurvey status, such as ACTIVE. The field can be absent in some returned records.
data.results[]ownerUserIdIntegerUnique identifier of the survey owner.
data.results[]createdTimeStringDate and time when the survey was created.
data.results[]modifiedTimeStringDate and time when the survey was last modified.
data.results[]modifiedByIntegerUnique identifier of the user who last modified the survey.
data.results[]baseLanguageStringBase language of the survey, such as en.
data.results[]parentHierarchyIdsArray of stringsParent hierarchy identifiers associated with the survey.
data.results[]surveyLanguagesArray of stringsAdditional configured survey languages.
errorsArrayError information. An empty array means no error was returned.

11. CFM Survey: Filter by survey name

Searches the survey name field for the supplied text by using CONTAINS.

Endpoint

POST /api/v3/search/cfmSurvey

Example request

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"
        ]
      }
    ]
  }
}'

Request parameters

ParameterSub-parameterRequiredTypeDescription
filterYesObjectDefines the criteria used to search for CFM surveys.
filtertypeYesStringLogical operator used to combine conditions. The examples use AND.
filterfiltersYesArray of objectsIndividual filter conditions. Use an empty array to apply no field-level filters.
filter.filters[]typeConditionalStringComparison operator, such as EQUALS, CONTAINS, GT, or LT. Required when a condition is supplied.
filter.filters[]keyConditionalStringSurvey field evaluated by the condition, such as status, id, parentHierarchyIds, name, ownerUserId, createdTime, or modifiedTime.
filter.filters[]valuesConditionalArrayOne or more values evaluated against the selected field.

Example response

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

Response parameters

ParameterSub-parameterTypeDescription
dataObjectContains the response payload.
dataresultsArray of objectsSurveys matching the request. An empty array means no matching records were returned.
data.results[]idStringUnique survey identifier.
data.results[]nameStringSurvey name.
data.results[]parentProgramIdStringUnique identifier of the parent program.
data.results[]parentProgramNameStringName of the parent program.
data.results[]statusStringSurvey status, such as ACTIVE. The field can be absent in some returned records.
data.results[]ownerUserIdIntegerUnique identifier of the survey owner.
data.results[]createdTimeStringDate and time when the survey was created.
data.results[]modifiedTimeStringDate and time when the survey was last modified.
data.results[]modifiedByIntegerUnique identifier of the user who last modified the survey.
data.results[]baseLanguageStringBase language of the survey, such as en.
data.results[]parentHierarchyIdsArray of stringsParent hierarchy identifiers associated with the survey.
data.results[]surveyLanguagesArray of stringsAdditional configured survey languages.
errorsArrayError information. An empty array means no error was returned.

12. CFM Survey: Filter by program name

The source example filters parentHierarchyIds; despite its original title, it does not send a program-name field.

Endpoint

POST /api/v3/search/cfmSurvey

Example request

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"
        ]
      }
    ]
  }
}'

Request parameters

ParameterSub-parameterRequiredTypeDescription
filterYesObjectDefines the criteria used to search for CFM surveys.
filtertypeYesStringLogical operator used to combine conditions. The examples use AND.
filterfiltersYesArray of objectsIndividual filter conditions. Use an empty array to apply no field-level filters.
filter.filters[]typeConditionalStringComparison operator, such as EQUALS, CONTAINS, GT, or LT. Required when a condition is supplied.
filter.filters[]keyConditionalStringSurvey field evaluated by the condition, such as status, id, parentHierarchyIds, name, ownerUserId, createdTime, or modifiedTime.
filter.filters[]valuesConditionalArrayOne or more values evaluated against the selected field.

Example response

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

Response parameters

ParameterSub-parameterTypeDescription
dataObjectContains the response payload.
dataresultsArray of objectsSurveys matching the request. An empty array means no matching records were returned.
data.results[]idStringUnique survey identifier.
data.results[]nameStringSurvey name.
data.results[]parentProgramIdStringUnique identifier of the parent program.
data.results[]parentProgramNameStringName of the parent program.
data.results[]statusStringSurvey status, such as ACTIVE. The field can be absent in some returned records.
data.results[]ownerUserIdIntegerUnique identifier of the survey owner.
data.results[]createdTimeStringDate and time when the survey was created.
data.results[]modifiedTimeStringDate and time when the survey was last modified.
data.results[]modifiedByIntegerUnique identifier of the user who last modified the survey.
data.results[]baseLanguageStringBase language of the survey, such as en.
data.results[]parentHierarchyIdsArray of stringsParent hierarchy identifiers associated with the survey.
data.results[]surveyLanguagesArray of stringsAdditional configured survey languages.
errorsArrayError information. An empty array means no error was returned.

13. CFM Survey: Filter by owner

Returns surveys whose ownerUserId exactly matches the supplied user ID.

Endpoint

POST /api/v3/search/cfmSurvey

Example request

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"
        ]
      }
    ]
  }
}'

Request parameters

ParameterSub-parameterRequiredTypeDescription
filterYesObjectDefines the criteria used to search for CFM surveys.
filtertypeYesStringLogical operator used to combine conditions. The examples use AND.
filterfiltersYesArray of objectsIndividual filter conditions. Use an empty array to apply no field-level filters.
filter.filters[]typeConditionalStringComparison operator, such as EQUALS, CONTAINS, GT, or LT. Required when a condition is supplied.
filter.filters[]keyConditionalStringSurvey field evaluated by the condition, such as status, id, parentHierarchyIds, name, ownerUserId, createdTime, or modifiedTime.
filter.filters[]valuesConditionalArrayOne or more values evaluated against the selected field.

Example response

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

Response parameters

ParameterSub-parameterTypeDescription
dataObjectContains the response payload.
dataresultsArray of objectsSurveys matching the request. An empty array means no matching records were returned.
data.results[]idStringUnique survey identifier.
data.results[]nameStringSurvey name.
data.results[]parentProgramIdStringUnique identifier of the parent program.
data.results[]parentProgramNameStringName of the parent program.
data.results[]statusStringSurvey status, such as ACTIVE. The field can be absent in some returned records.
data.results[]ownerUserIdIntegerUnique identifier of the survey owner.
data.results[]createdTimeStringDate and time when the survey was created.
data.results[]modifiedTimeStringDate and time when the survey was last modified.
data.results[]modifiedByIntegerUnique identifier of the user who last modified the survey.
data.results[]baseLanguageStringBase language of the survey, such as en.
data.results[]parentHierarchyIdsArray of stringsParent hierarchy identifiers associated with the survey.
data.results[]surveyLanguagesArray of stringsAdditional configured survey languages.
errorsArrayError information. An empty array means no error was returned.

14. CFM Survey: Filter by surveys created after a time

Uses GT on createdTime to return surveys created after the supplied epoch-millisecond value.

Endpoint

POST /api/v3/search/cfmSurvey

Example request

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
        ]
      }
    ]
  }
}'

Request parameters

ParameterSub-parameterRequiredTypeDescription
filterYesObjectDefines the criteria used to search for CFM surveys.
filtertypeYesStringLogical operator used to combine conditions. The examples use AND.
filterfiltersYesArray of objectsIndividual filter conditions. Use an empty array to apply no field-level filters.
filter.filters[]typeConditionalStringComparison operator, such as EQUALS, CONTAINS, GT, or LT. Required when a condition is supplied.
filter.filters[]keyConditionalStringSurvey field evaluated by the condition, such as status, id, parentHierarchyIds, name, ownerUserId, createdTime, or modifiedTime.
filter.filters[]valuesConditionalArrayOne or more values evaluated against the selected field.

Example response

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

Response parameters

ParameterSub-parameterTypeDescription
dataObjectContains the response payload.
dataresultsArray of objectsSurveys matching the request. An empty array means no matching records were returned.
data.results[]idStringUnique survey identifier.
data.results[]nameStringSurvey name.
data.results[]parentProgramIdStringUnique identifier of the parent program.
data.results[]parentProgramNameStringName of the parent program.
data.results[]statusStringSurvey status, such as ACTIVE. The field can be absent in some returned records.
data.results[]ownerUserIdIntegerUnique identifier of the survey owner.
data.results[]createdTimeStringDate and time when the survey was created.
data.results[]modifiedTimeStringDate and time when the survey was last modified.
data.results[]modifiedByIntegerUnique identifier of the user who last modified the survey.
data.results[]baseLanguageStringBase language of the survey, such as en.
data.results[]parentHierarchyIdsArray of stringsParent hierarchy identifiers associated with the survey.
data.results[]surveyLanguagesArray of stringsAdditional configured survey languages.
errorsArrayError information. An empty array means no error was returned.

15. CFM Survey: Filter by created time using LT

Uses LT on createdTime to return surveys created before the supplied epoch-millisecond value.

Endpoint

POST /api/v3/search/cfmSurvey

Example request

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
        ]
      }
    ]
  }
}'

Request parameters

ParameterSub-parameterRequiredTypeDescription
filterYesObjectDefines the criteria used to search for CFM surveys.
filtertypeYesStringLogical operator used to combine conditions. The examples use AND.
filterfiltersYesArray of objectsIndividual filter conditions. Use an empty array to apply no field-level filters.
filter.filters[]typeConditionalStringComparison operator, such as EQUALS, CONTAINS, GT, or LT. Required when a condition is supplied.
filter.filters[]keyConditionalStringSurvey field evaluated by the condition, such as status, id, parentHierarchyIds, name, ownerUserId, createdTime, or modifiedTime.
filter.filters[]valuesConditionalArrayOne or more values evaluated against the selected field.

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": []
}

Response parameters

ParameterSub-parameterTypeDescription
dataObjectContains the response payload.
dataresultsArray of objectsSurveys matching the request. An empty array means no matching records were returned.
data.results[]idStringUnique survey identifier.
data.results[]nameStringSurvey name.
data.results[]parentProgramIdStringUnique identifier of the parent program.
data.results[]parentProgramNameStringName of the parent program.
data.results[]statusStringSurvey status, such as ACTIVE. The field can be absent in some returned records.
data.results[]ownerUserIdIntegerUnique identifier of the survey owner.
data.results[]createdTimeStringDate and time when the survey was created.
data.results[]modifiedTimeStringDate and time when the survey was last modified.
data.results[]modifiedByIntegerUnique identifier of the user who last modified the survey.
data.results[]baseLanguageStringBase language of the survey, such as en.
data.results[]parentHierarchyIdsArray of stringsParent hierarchy identifiers associated with the survey.
data.results[]surveyLanguagesArray of stringsAdditional configured survey languages.
errorsArrayError information. An empty array means no error was returned.

16. CFM Survey: Filter by created time using EQUALS

Returns surveys whose createdTime exactly matches the supplied epoch-millisecond value.

Endpoint

POST /api/v3/search/cfmSurvey

Example request

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
        ]
      }
    ]
  }
}'

Request parameters

ParameterSub-parameterRequiredTypeDescription
filterYesObjectDefines the criteria used to search for CFM surveys.
filtertypeYesStringLogical operator used to combine conditions. The examples use AND.
filterfiltersYesArray of objectsIndividual filter conditions. Use an empty array to apply no field-level filters.
filter.filters[]typeConditionalStringComparison operator, such as EQUALS, CONTAINS, GT, or LT. Required when a condition is supplied.
filter.filters[]keyConditionalStringSurvey field evaluated by the condition, such as status, id, parentHierarchyIds, name, ownerUserId, createdTime, or modifiedTime.
filter.filters[]valuesConditionalArrayOne or more values evaluated against the selected field.

Example response

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

Response parameters

ParameterSub-parameterTypeDescription
dataObjectContains the response payload.
dataresultsArray of objectsSurveys matching the request. An empty array means no matching records were returned.
data.results[]idStringUnique survey identifier.
data.results[]nameStringSurvey name.
data.results[]parentProgramIdStringUnique identifier of the parent program.
data.results[]parentProgramNameStringName of the parent program.
data.results[]statusStringSurvey status, such as ACTIVE. The field can be absent in some returned records.
data.results[]ownerUserIdIntegerUnique identifier of the survey owner.
data.results[]createdTimeStringDate and time when the survey was created.
data.results[]modifiedTimeStringDate and time when the survey was last modified.
data.results[]modifiedByIntegerUnique identifier of the user who last modified the survey.
data.results[]baseLanguageStringBase language of the survey, such as en.
data.results[]parentHierarchyIdsArray of stringsParent hierarchy identifiers associated with the survey.
data.results[]surveyLanguagesArray of stringsAdditional configured survey languages.
errorsArrayError information. An empty array means no error was returned.

17. CFM Survey: Filter by surveys updated after a time

Uses GT on modifiedTime to return surveys updated after the supplied epoch-millisecond value.

Endpoint

POST /api/v3/search/cfmSurvey

Example request

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"
        ]
      }
    ]
  }
}'

Request parameters

ParameterSub-parameterRequiredTypeDescription
filterYesObjectDefines the criteria used to search for CFM surveys.
filtertypeYesStringLogical operator used to combine conditions. The examples use AND.
filterfiltersYesArray of objectsIndividual filter conditions. Use an empty array to apply no field-level filters.
filter.filters[]typeConditionalStringComparison operator, such as EQUALS, CONTAINS, GT, or LT. Required when a condition is supplied.
filter.filters[]keyConditionalStringSurvey field evaluated by the condition, such as status, id, parentHierarchyIds, name, ownerUserId, createdTime, or modifiedTime.
filter.filters[]valuesConditionalArrayOne or more values evaluated against the selected field.

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": []
}

Response parameters

ParameterSub-parameterTypeDescription
dataObjectContains the response payload.
dataresultsArray of objectsSurveys matching the request. An empty array means no matching records were returned.
data.results[]idStringUnique survey identifier.
data.results[]nameStringSurvey name.
data.results[]parentProgramIdStringUnique identifier of the parent program.
data.results[]parentProgramNameStringName of the parent program.
data.results[]statusStringSurvey status, such as ACTIVE. The field can be absent in some returned records.
data.results[]ownerUserIdIntegerUnique identifier of the survey owner.
data.results[]createdTimeStringDate and time when the survey was created.
data.results[]modifiedTimeStringDate and time when the survey was last modified.
data.results[]modifiedByIntegerUnique identifier of the user who last modified the survey.
data.results[]baseLanguageStringBase language of the survey, such as en.
data.results[]parentHierarchyIdsArray of stringsParent hierarchy identifiers associated with the survey.
data.results[]surveyLanguagesArray of stringsAdditional configured survey languages.
errorsArrayError information. An empty array means no error was returned.

18. CFM Survey: Multiple filters: status and owner

Returns surveys that have ACTIVE status and are owned by the specified user.

Endpoint

POST /api/v3/search/cfmSurvey

Example request

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"
        ]
      }
    ]
  }
}'

Request parameters

ParameterSub-parameterRequiredTypeDescription
filterYesObjectDefines the criteria used to search for CFM surveys.
filtertypeYesStringLogical operator used to combine conditions. The examples use AND.
filterfiltersYesArray of objectsIndividual filter conditions. Use an empty array to apply no field-level filters.
filter.filters[]typeConditionalStringComparison operator, such as EQUALS, CONTAINS, GT, or LT. Required when a condition is supplied.
filter.filters[]keyConditionalStringSurvey field evaluated by the condition, such as status, id, parentHierarchyIds, name, ownerUserId, createdTime, or modifiedTime.
filter.filters[]valuesConditionalArrayOne or more values evaluated against the selected field.

Example response

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

Response parameters

ParameterSub-parameterTypeDescription
dataObjectContains the response payload.
dataresultsArray of objectsSurveys matching the request. An empty array means no matching records were returned.
data.results[]idStringUnique survey identifier.
data.results[]nameStringSurvey name.
data.results[]parentProgramIdStringUnique identifier of the parent program.
data.results[]parentProgramNameStringName of the parent program.
data.results[]statusStringSurvey status, such as ACTIVE. The field can be absent in some returned records.
data.results[]ownerUserIdIntegerUnique identifier of the survey owner.
data.results[]createdTimeStringDate and time when the survey was created.
data.results[]modifiedTimeStringDate and time when the survey was last modified.
data.results[]modifiedByIntegerUnique identifier of the user who last modified the survey.
data.results[]baseLanguageStringBase language of the survey, such as en.
data.results[]parentHierarchyIdsArray of stringsParent hierarchy identifiers associated with the survey.
data.results[]surveyLanguagesArray of stringsAdditional configured survey languages.
errorsArrayError information. An empty array means no error was returned.

19. CFM Survey: Pagination

Limits the number of records returned and specifies the zero-based starting position.

Endpoint

POST /api/v3/search/cfmSurvey

Example request

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"
        ]
      }
    ]
  }
}'

Request parameters

ParameterSub-parameterRequiredTypeDescription
pageNoObjectControls pagination.
pagesizeNoIntegerMaximum number of survey records returned. The example requests one record.
pagestartNoIntegerZero-based starting position. The example begins at the first record.
filterYesObjectDefines the survey filter criteria.
filtertypeYesStringLogical operator used to combine conditions.
filterfiltersYesArray of objectsIndividual filter conditions.
filter.filters[]typeYesStringComparison operator. The example uses EQUALS.
filter.filters[]keyYesStringField to filter. The example uses status.
filter.filters[]valuesYesArrayValues evaluated against the selected field.

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": []
}

Response parameters

ParameterSub-parameterTypeDescription
dataObjectContains the response payload.
dataresultsArray of objectsSurveys matching the request. An empty array means no matching records were returned.
data.results[]idStringUnique survey identifier.
data.results[]nameStringSurvey name.
data.results[]parentProgramIdStringUnique identifier of the parent program.
data.results[]parentProgramNameStringName of the parent program.
data.results[]statusStringSurvey status, such as ACTIVE. The field can be absent in some returned records.
data.results[]ownerUserIdIntegerUnique identifier of the survey owner.
data.results[]createdTimeStringDate and time when the survey was created.
data.results[]modifiedTimeStringDate and time when the survey was last modified.
data.results[]modifiedByIntegerUnique identifier of the user who last modified the survey.
data.results[]baseLanguageStringBase language of the survey, such as en.
data.results[]parentHierarchyIdsArray of stringsParent hierarchy identifiers associated with the survey.
data.results[]surveyLanguagesArray of stringsAdditional configured survey languages.
errorsArrayError information. An empty array means no error was returned.

20. CFM Survey: Unauthorized request, 401

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.

Endpoint

POST /api/v3/search/cfmSurvey

Example request

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": []
  }
}'

Request parameters

ParameterSub-parameterRequiredTypeDescription
filterYesObjectDefines the criteria used to search for CFM surveys.
filtertypeYesStringLogical operator used to combine conditions. The examples use AND.
filterfiltersYesArray of objectsIndividual filter conditions. Use an empty array to apply no field-level filters.
filter.filters[]typeConditionalStringComparison operator, such as EQUALS, CONTAINS, GT, or LT. Required when a condition is supplied.
filter.filters[]keyConditionalStringSurvey field evaluated by the condition, such as status, id, parentHierarchyIds, name, ownerUserId, createdTime, or modifiedTime.
filter.filters[]valuesConditionalArrayOne or more values evaluated against the selected field.

Example response

{
  "data": null,
  "errors": [
    {
      "code": 401,
      "message": "Unauthorized"
    }
  ]
}

Error response parameters

ParameterSub-parameterTypeDescription
dataObject or nullResponse data. It can be null when authentication fails.
errorsArray of objectsContains authentication error details.
errors[]codeIntegerHTTP or application error code. The example uses 401.
errors[]messageStringHuman-readable error description.

Appendix A. Filter operators used in this guide

OperatorMeaningExample use
EQUALSExact matchStatus, survey ID, program hierarchy ID, owner ID, or exact creation time
CONTAINSText contains a supplied valueSurvey name
GTGreater thanCreated or modified after an epoch-millisecond value
LTLess thanCreated before an epoch-millisecond value

Appendix B. Important validation notes

  • 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 results array 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 401 example in this guide is a normalized documentation example and should be validated against an actual unauthorized response before publication.

20 Use Case

20.1 Retrieve available surveys

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.

20.2 Find surveys using specific criteria

Search for surveys by attributes such as status, survey ID, program hierarchy ID, survey name, owner, creation time, or modification time.

20.3 Refine survey searches using multiple filters

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.

20.4 Retrieve large sets of survey results using pagination

Paginate survey search results by controlling the number of records returned and the starting position, making larger result sets easier to retrieve and process.