Analytics2

Assets5

Audit Events1

Auth2

Certificates2

Clients6

Courses4

Domains2

Dynamic Client Registration1

Enrollments5

Groups10

Lessons4

Paths6

Published Courses7

Published Paths24

Question Banks5

Questions5

Quizzes9

Scopes2

Signup Field Values4

Students11

Web Packages5

Signup Field Values

List signup field values

Changed on Oct 16, 2026

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

Required OAuth scope: signup-fields:read

get/v2/signup-field-values/

Request

Base URL
https://api.skilljar.com (the document declares no server; this is the origin it was published from)
Auth
HTTP bearer
TypeScript
https://skmtc.dev/skilljar/apis/skilljar-api-v2/docs/v2/signup-field-values/get.ts
A function with typed inputs. Its response is checked against the schema.

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

OK

metaobject nullable

Pagination metadata, e.g. {"page_size": 25}.

includedobject[] nullable

Related resources requested via ?include=. Absent when no include was requested.

Changes

Oct 16, 2026bed169429eb2 Revision changes
- breaking
  removed the required property from the response with the status
- warning
  removed the optional property from the response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added to the response property anyOf list for the response status
- info
  removed subschema #1 from the response property anyOf list for the response status
Sep 15, 20269fc34e55336d Revision changes
- info
  media type application/json was changed to a more specific media type application/vnd.api+json for the response status
- info
  media type application/json was changed to a more specific media type application/vnd.api+json for the response status
- info
  media type application/json was changed to a more specific media type application/vnd.api+json for the response status
- info
  media type application/json was changed to a more specific media type application/vnd.api+json for the response status
- info
  media type application/json was changed to a more specific media type application/vnd.api+json for the response status

Operation history