# Get service provider onboarding templates

Get all onboarding templates

Endpoint: GET /service-providers/{sp_id}/onboarding-templates
Version: 1.0.0
Security: access_auth

## Path parameters:

  - `sp_id` (string, required)
    Service Provider Id

## Response 200 fields (application/json):

  - `template_id` (string, required)
    ID of this template

  - `date_created` (string, required)

  - `date_updated` (string, required)

  - `updated_by` (string, required)

  - `created_by` (string, required)

  - `version` (string, required)
    Current template version. Will be "draft" if unpublished changes

  - `name` (string, required)
    Template name. Internal only

  - `description` (string, required)
    Template description. Internal only

  - `custom_field_sections` (array, required)
    Custom fields array. These are a list of freeform questions to collect any information from your clients.

  - `custom_field_sections.fields` (array, required)

  - `custom_field_sections.fields.label` (string, required)

  - `custom_field_sections.fields.type` (string, required)
    Enum: "textSingleLine", "textMultiLine", "radio", "select", "checkbox", "date", "file", "fileDownload", "displayContent", "hyperlink"

  - `custom_field_sections.fields.id` (string, required)

  - `custom_field_sections.fields.attachments` (array)
    List of file names and document IDs of files attached to this field. Used in File and Display Content fields

  - `custom_field_sections.fields.attachments.file_name` (string, required)

  - `custom_field_sections.fields.paragraph` (string)
    Paragraph of text. Used in Display Content

  - `custom_field_sections.fields.smart_rule` (object)

  - `custom_field_sections.fields.smart_rule.action` (string, required)
    The desired action to take on the field if all conditions are true
    Enum: "Show", "Hide"

  - `custom_field_sections.fields.smart_rule.conditions` (array, required)
    Array of conditions that must all be met in order for the rule to evaluate true. Currently limited to one condition but using an array to make it easier to extend

  - `custom_field_sections.fields.smart_rule.conditions.operator` (string, required)
    The different condition operators to use
    Enum: "Is Equal To", "Is Not Equal To", "Is Empty", "Is Filled"

  - `custom_field_sections.fields.smart_rule.conditions.targetFieldId` (string, required)
    The field to check the value of against the target value

  - `custom_field_sections.fields.smart_rule.conditions.targetValue` (string)
    The value upon which the operator checks against the target field's value

  - `custom_field_sections.fields.required` (boolean)
    Set to true if this field should be required in the form

  - `custom_field_sections.fields.helpText` (string)
    Tooltip text

  - `custom_field_sections.order` (number, required)

  - `custom_field_sections.section_id` (string, required)

  - `custom_field_sections.description` (string)

  - `document_requirements` (array, required)

  - `document_requirements.required` (boolean, required)

  - `document_requirements.category` (string, required)
    Enum: "financial", "legal", "license", "operational"

  - `document_requirements.name` (string, required)

  - `document_requirements.requirement_id` (string, required)

  - `document_requirements.archived` (boolean)

  - `document_requirements.attachments` (array)

  - `published_date` (string)

  - `published_by` (string)

## Response 401 fields (application/json):

  - `name` (string, required)

  - `message` (string, required)

  - `status` (number, required)

  - `stack` (string)

  - `data` (any)

## Response 403 fields (application/json):

  - `name` (string, required)

  - `message` (string, required)

  - `status` (number, required)

  - `stack` (string)

  - `data` (any)

## Response 404 fields (application/json):

  - `name` (string, required)

  - `message` (string, required)

  - `status` (number, required)

  - `stack` (string)

  - `data` (any)

## Response 422 fields (application/json):

  - `name` (string, required)

  - `message` (string, required)

  - `status` (number, required)

  - `fields` (object, required)

  - `stack` (string)

  - `data` (any)