latestOpenAPI 3.1.02026-08-1182263351.1 KB

f8025de20169

Signup Field Values

List signup field values

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

Required OAuth scope: signup-fields:read

get/v2/signup-field-values/

Query parameters

filter[student.id]string nullable

Return only values for the student with this opaque id. Unknown ids match nothing.

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.

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.

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.

Maximum number of records to return.

page[cursor]string nullable

Opaque cursor from the previous page's links.next.

Opaque cursor from the previous page's links.next.

Response

OK

metaobject nullable

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

linksobject nullable

Pagination links, e.g. {"self": "...", "next": "...", "prev": null}.

has_moreboolean required

Whether additional pages exist after this one.

next_cursorstring nullable

Opaque cursor to pass as page[cursor] for the next page; null on the last page.

includedobject[] nullable

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