Skilljar

Skilljar Domains > Signup Fields API

The Domains > Signup Fields API from Skilljar — 1 operation(s) for domains > signup fields.

Documentation GitHub OpenAPI

Operations 1

GET /v1/domains/{domain_name}/signup-fields #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/skilljar-domains-signup-fields-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Skilljar Assets Domains > Signup Fields API
  version: 1.0.0
  description: 'The Skilljar API provides comprehensive access to our customer education platform, enabling you to programmatically manage courses, users, enrollments, and more.


    This interactive documentation is automatically generated from our codebase and stays current with the latest features and endpoints.


    ## Getting Started


    New to the Skilljar API? Check out these essential resources:


    - **[API Getting Started Guide](https://support.gainsight.com/Skilljar/Develop_and_Customize/API/Getting_started_with_the_Skilljar_API)** - Authentication, basic concepts, and your first API call

    - **[Token-based SSO](https://support.gainsight.com/Skilljar/Develop_and_Customize/Single_Sign_on_(SSO)/Configuring_Token-Based_Single_Sign-On_(SSO))** - Seamlessly integrate user authentication

    - **[Webhooks](https://support.gainsight.com/Skilljar/Develop_and_Customize/API/Using_Webhooks_API)** - Real-time notifications for platform events

    '
servers:
- url: https://api.skilljar.com/v1/
  description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: Domains > Signup Fields
paths:
  /v1/domains/{domain_name}/signup-fields:
    get:
      operationId: domains_signup_fields_list
      description: Manage signup fields for a domain. Signup fields define the information collected from users during the signup process for a specific domain. Each field may have a set of options, validation rules, and display properties. Use this endpoint to view the list of signup fields configured for a domain.
      parameters:
      - in: path
        name: domain_name
        schema:
          type: string
          pattern: ^[-:\.0-9a-z]+$
        required: true
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      tags:
      - Domains > Signup Fields
      security:
      - OrganizationApiKey: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedSignupFieldList'
          description: ''
components:
  schemas:
    PaginatedSignupFieldList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/SignupField'
    SignupField:
      type: object
      properties:
        id:
          type: string
          readOnly: true
          description: Known as signup_field_id within the documentation
        type:
          $ref: '#/components/schemas/SignupFieldTypeEnum'
        label:
          type: string
        help_text:
          type: string
          maxLength: 4096
        regex_validator:
          type: string
          maxLength: 500
        regex_validator_error_text:
          type: string
          maxLength: 100
        required:
          type: boolean
        active:
          type: boolean
        order:
          type: integer
          maximum: 2147483647
          minimum: 0
          description: 'Default field orders: (1000 Private Domain Code), 3000 First/Last Name, 4000 Email, 5000 Password, 6000 Confirm Password'
        options:
          type: array
          items:
            $ref: '#/components/schemas/SignupFieldOption'
          readOnly: true
      required:
      - label
    SignupFieldOption:
      type: object
      properties:
        id:
          type: string
          readOnly: true
        value:
          type: string
          maxLength: 100
      required:
      - value
    SignupFieldTypeEnum:
      enum:
      - TEXT
      - PICKLIST
      - CHECKBOX
      type: string
      description: '* `TEXT` - Free-Form Text

        * `PICKLIST` - Pick-List

        * `CHECKBOX` - Checkbox'
  securitySchemes:
    OrganizationApiKey:
      type: http
      scheme: basic
      description: API key authentication using HTTP Basic Auth. Use your API key as the username and leave password empty.
    tokenAuth:
      type: http
      scheme: bearer