PRproductive
Survey Fields

Get survey fields

Changed on

List all survey fields.

get/api/v2/survey_fields

Request

  • Base URL
    https://developer.productive.io (the document declares no server; this is the origin it was published from)
  • URL
    https://developer.productive.io/api/v2/survey_fields
  • Auth
    none declared

Query parameters

OR

Filter parameter for querying survey fields.

{
  "0": {
    "id": {
      "eq": "123"
    }
  },
  "$op": "and"
}
sortstring[]

Sort order for survey field list results. Accepts one or more field names, comma-separated; prefix with - for descending. --branch descriptions

Response

Collection survey field

Example response

{
  "data": [
    {
      "id": "45",
      "type": "survey_fields",
      "attributes": {
        "label": "How satisfied are you with the project outcome?",
        "field_type": "rating",
        "required": true,
        "position": 1
      },
      "relationships": {
        "survey": {
          "data": {
            "type": "surveys",
            "id": "7"
          }
        }
      }
    }
  ],
  "included": [],
  "meta": {
    "current_page": 1,
    "total_pages": 5,
    "total_count": 42,
    "page_size": 30,
    "max_page_size": 200
  }
}

Changes

  • fa3060fd0144Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • f11a8740641aRevision changes
    • breaking

      the /// response's property type changed from integer to no type for status

    • breaking

      the /// response's property type changed from string to no type, and format from date-time to no format for status

    • breaking

      the /// response's property type changed from integer to no type for status

    • breaking

      the /// response's property type changed from boolean to no type for status

    • warning

      deleted the header request parameter X-Organization-Id

    This list may be incomplete.