1. v3
  2. Surveys
  3. GET - 3/surveys/sso

Definition

GET - 3/surveys/sso?status={status}&top={top}&skip={skip}

Retrieve the surveys of your account that require SSO, with their SSO settings.

  • The owner of the API key needs a survey SSO permission. * Only the surveys the owner of the API key can open are returned. * Deleted surveys are not returned.

Request information

status

Only the surveys in this SSO state: on_no_attributes, on_non_pii_attributes or on_all_attributes. Without it, every survey that requires SSO is returned.


Type string
Additional info
Optional
top

Select only the first N surveys of the list, at most 1000. read more


Type string
Additional info
Optional, Default value is 25
skip

Skip the first N surveys of the list. read more


Type string
Additional info
Optional

Response information

Payload containing a list of SSO surveys.


Meta

The metadata such as paging parameters, status code, timestamp,... which are related to this request.


Type MetaData
Data

The actual data returned by the request.


Type Collection of SsoSurveySummary
Links

HATEOAS related to this object. It wil contain relevant url's such as previous and next page for paged results, create/update/delete action. These url's can be used in your application for the next steps in your application logic.


Type Hateoas

Note about API metadata
The API uses the same metadata structure for all endpoints, but not every field applies to every endpoint. Fields such as paging details (for example Limit, Offset and TotalRowCount) and IsFiltered are only returned by endpoints that support them. Fields that do not apply are not included in the actual response.
Sample: 
{
  "Meta": {
    "Status": 1,
    "TotalRowCount": 1,
    "Limit": 1,
    "Offset": 1,
    "TotalPageCount": 1,
    "StartRec": 1,
    "StopRec": 1,
    "Timestamp": "2026-11-13T20:04:51.5631756Z",
    "IsFiltered": true
  },
  "Data": [
    {
      "SurveyId": 1,
      "Title": "sample string 2",
      "OwnerUserId": 3,
      "OwnerDisplayName": "sample string 4",
      "SsoStatus": "off",
      "IdentityMatchEnabled": true,
      "IdentityMatchContactField": "sample string 6",
      "IdentityMatchClaimName": "sample string 7"
    },
    {
      "SurveyId": 1,
      "Title": "sample string 2",
      "OwnerUserId": 3,
      "OwnerDisplayName": "sample string 4",
      "SsoStatus": "off",
      "IdentityMatchEnabled": true,
      "IdentityMatchContactField": "sample string 6",
      "IdentityMatchClaimName": "sample string 7"
    }
  ]
}
Sample: 
<Payload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
  <Data>
    <SsoSurveySummary z:Id="i2">
      <IdentityMatchClaimName>sample string 7</IdentityMatchClaimName>
      <IdentityMatchContactField>sample string 6</IdentityMatchContactField>
      <IdentityMatchEnabled>true</IdentityMatchEnabled>
      <OwnerDisplayName>sample string 4</OwnerDisplayName>
      <OwnerUserId>3</OwnerUserId>
      <SsoStatus>off</SsoStatus>
      <SurveyId>1</SurveyId>
      <Title>sample string 2</Title>
    </SsoSurveySummary>
    <SsoSurveySummary z:Ref="i2" />
  </Data>
  <Meta>
    <IsFiltered>true</IsFiltered>
    <Limit>1</Limit>
    <Offset>1</Offset>
    <StartRec>1</StartRec>
    <Status>1</Status>
    <StopRec>1</StopRec>
    <Timestamp>2026-11-13T20:04:51.5631756+00:00</Timestamp>
    <TotalPageCount>1</TotalPageCount>
    <TotalRowCount>1</TotalRowCount>
  </Meta>
</Payload>