---
title: "List signup field values"
method: GET
path: "/v2/signup-field-values/"
tags: ["Signup Field Values"]
---

# List signup field values

`GET /v2/signup-field-values/`

List the organization's captured signup-field values, one row per value.

**Required OAuth scope:** `signup-fields:read`

## Query parameters

- `filter[student.id]` string, nullable — Return only values for the student with this opaque id. Unknown ids match nothing.
- `filter[signup-field.id]` string, nullable — Return only values for the signup field with this opaque id. Unknown ids match nothing.
- `filter[domains]` string, nullable — Comma-separated domain names; returns only values whose signup field is in one of those domains. Unknown names match nothing, never error.
- `page[size]` integer — Maximum number of records to return.
- `page[cursor]` string, nullable — Opaque cursor from the previous page's links.next.

## Response `200`

OK

- PaginatedListResponseSignupFieldValueResource
  - `data` SignupFieldValueResource[], required — The resources on this page, in cursor order.
    - `type` string — Always "signup-field-values".
    - `id` string, required — Opaque signup-field-value ID.
    - `attributes` SignupFieldValueAttributes, required — Attributes of a signup-field-value resource.
      - `label` string, required — The signup field's display label.
      - `value` string, required — The student's answer for this field.
    - `relationships` SignupFieldValueRelationships, required — Relationships of a signup-field-value resource.
      - `student` StudentRelationship, required — To-one linkage to a student; ``data`` is null when there is no student.
        - `data` StudentIdentifier — JSON:API resource identifier for a student.
          - `type` string — Always "students".
          - `id` string, required — Opaque student ID.
      - `signup-field` SignupFieldRelationship, required — To-one linkage to a signup field.
        - `data` SignupFieldIdentifier, required — JSON:API resource identifier for a signup field.
          - `type` string — Always "signup-fields".
          - `id` string, required — Opaque signup-field ID.
  - `meta` object, nullable — Pagination metadata, e.g. {"page_size": 25}.
  - `links` object, nullable — Pagination links, e.g. {"self": "...", "next": "...", "prev": null}.
  - `has_more` boolean, required — Whether additional pages exist after this one.
  - `next_cursor` string, nullable — Opaque cursor to pass as ``page[cursor]`` for the next page; null on the last page.
  - `included` object[], nullable — Related resources requested via ?include=. Absent when no include was requested.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `422` — Unprocessable Entity

---

[API](https://skmtc.net/skilljar/apis/skilljar-api-v2.md) · [All operations](https://skmtc.net/skilljar/apis/skilljar-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/skilljar/skilljar-api-v2/revisions/f8025de20169/schema)