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/getsmileapi:getsmileapi-invite-templates-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: Smile Invite Templates API
  version: 1.14.0
  description: The Smile API provides employment and income data from a single API.
  contact:
    name: Smile Technology Pte Ltd
    url: https://www.getsmileapi.com
    email: info@getsmileapi.com
  termsOfService: https://www.getsmileapi.com/terms-and-conditions
servers:
- url: https://sandbox.smileapi.io/v1
  description: Sandbox
- url: https://open.smileapi.io/v1
  description: Production
security:
- basicAuth: []
tags:
- name: Invite Templates
paths:
  /inviteTemplates:
    get:
      summary: List Invite Templates
      tags:
      - Invite Templates
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InviteTemplateListResponse'
              examples:
                Example:
                  value:
                    code: OK
                    message: Success
                    requestId: 5b79399a-6852-4234-bb0e-ad472648282d
                    data:
                      nextCursor: '1259723474'
                      items:
                      - id: 17bbf36498de4d68a0d4f86c7b62f69f
                        name: Email Template v1
                        company:
                          name: XYZ Bank
                          logoUrl: https://xyzbank.co/logo.png
                        email:
                          sendEmail: true
                          senderName: XYZ Bank
                          replyAddress: replies@xyz.co
                          subject: Please connect your work account to share your data with us
                          body: Hello ${firstName}! We are working with our partner, Smile API, so you can easily share your employment and income data to us as a requirement for giving you service. It will be a quick process and should take no more than a few seconds of your time.
                        landingPage:
                          header: Share your employment and income data with us at ${companyName}
                          description: We are working with our partner, Smile API, so you can easily share your employment and income data to us as a requirement for giving you service. It will be a quick process and should take no more than a few seconds of your time.
                          button: START NOW
                        successPage:
                          header: Thank you for sharing your employment and income data with us at ${companyName}
                          description: The process was successful! Please wait for us to get in touch!
                          button: Connect another account
      operationId: list-invite-templates
      description: Get the list of invite templates.
      parameters:
      - $ref: '#/components/parameters/size'
      - $ref: '#/components/parameters/cursor'
    post:
      summary: Create Invite Template
      operationId: create-invite-template
      responses:
        '201':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InviteTemplatePostResponse'
              examples:
                Example:
                  value:
                    code: OK
                    message: Success
                    requestId: 5b79399a-6852-4234-bb0e-ad472648282d
                    data:
                      id: 17bbf36498de4d68a0d4f86c7b62f69f
                      name: Email Template v1
                      company:
                        name: XYZ Bank
                        logoUrl: https://xyzbank.co/logo.png
                      email:
                        sendEmail: true
                        senderName: XYZ Bank
                        replyAddress: replies@xyz.co
                        subject: Please connect your work account to share your data with us
                        body: Hello ${firstName}! We are working with our partner, Smile API, so you can easily share your employment and income data to us as a requirement for giving you service. It will be a quick process and should take no more than a few seconds of your time.
                      landingPage:
                        header: Share your employment and income data with us at {$companyName}
                        description: We are working with our partner, Smile API, so you can easily share your employment and income data to us as a requirement for giving you service. It will be a quick process and should take no more than a few seconds of your time.
                        button: START NOW
                      successPage:
                        header: Thank you for sharing your employment and income data with us at ${companyName}
                        description: The process was successful! Please wait for us to get in touch!
                        button: Connect another account
      description: Create an invite template.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InviteTemplatePostRequest'
            examples:
              Example:
                value:
                  name: Email Template v1
                  company:
                    name: XYZ Bank
                    logoUrl: https://xyzbank.co/logo.png
                  email:
                    sendEmail: true
                    senderName: XYZ Bank
                    replyAddress: replies@xyz.co
                    subject: Please connect your work account to share your data with us
                    body: Hello {{firstName}}, We are working with our partner, Smile API, so you can easily share your employment and income data to us as a requirement for giving you service. It will be a quick process and should take no more than a few seconds of your time.
                  landingPage:
                    header: We are working with our partner, Smile API, so you can easily share your employment and income data to us as a requirement for giving you service. It will be a quick process and should take no more than a few seconds of your time.
                    description: Share your employment and income data with us at {{company.name}}
                    button: START NOW
                  successPage:
                    header: The process was successful! Please wait for us to get in touch!
                    description: Thank you for sharing your employment and income data with us at {{company.name}}
                    button: Connect another account
        description: ''
      tags:
      - Invite Templates
  /inviteTemplates/{id}:
    parameters:
    - $ref: '#/components/parameters/id'
    get:
      summary: Get Invite Template
      tags:
      - Invite Templates
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InviteTemplateGetResponse'
              examples:
                Example:
                  value:
                    code: OK
                    message: Success
                    requestId: 5b79399a-6852-4234-bb0e-ad472648282d
                    data:
                      id: 17bbf36498de4d68a0d4f86c7b62f69f
                      name: Email Template v1
                      company:
                        name: XYZ Bank
                        logoUrl: https://xyzbank.co/logo.png
                      email:
                        sendEmail: true
                        senderName: XYZ Bank
                        replyAddress: replies@xyz.co
                        subject: Please connect your work account to share your data with us
                        body: Hello ${firstName}! We are working with our partner, Smile API, so you can easily share your employment and income data to us as a requirement for giving you service. It will be a quick process and should take no more than a few seconds of your time.
                      landingPage:
                        header: Share your employment and income data with us at ${companyName}
                        description: We are working with our partner, Smile API, so you can easily share your employment and income data to us as a requirement for giving you service. It will be a quick process and should take no more than a few seconds of your time.
                        button: START NOW
                      successPage:
                        header: Thank you for sharing your employment and income data with us at ${companyName}
                        description: The process was successful! Please wait for us to get in touch!
                        button: Connect another account
      operationId: get-invite-template
      description: Get invite template.
    put:
      summary: Update Invite Template
      operationId: update-invite-template
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InviteTemplateUpdateResponse'
              examples:
                Example:
                  value:
                    code: OK
                    message: Success
                    requestId: 5b79399a-6852-4234-bb0e-ad472648282d
                    data:
                      id: 17bbf36498de4d68a0d4f86c7b62f69f
                      name: Email Template v1
                      company:
                        name: XYZ Bank
                        logoUrl: https://xyzbank.co/logo.png
                      email:
                        sendEmail: true
                        senderName: XYZ Bank
                        replyAddress: replies@xyz.co
                        subject: Please connect your work account to share your data with us
                        body: Hello {$firstName}! We are working with our partner, Smile API, so you can easily share your employment and income data to us as a requirement for giving you service. It will be a quick process and should take no more than a few seconds of your time.
                      landingPage:
                        header: Share your employment and income data with us at {$companyName}
                        description: We are working with our partner, Smile API, so you can easily share your employment and income data to us as a requirement for giving you service. It will be a quick process and should take no more than a few seconds of your time.
                        button: START NOW
                      successPage:
                        header: Thank you for sharing your employment and income data with us at {$companyName}
                        description: The process was successful! Please wait for us to get in touch!
                        button: Connect another account
      tags:
      - Invite Templates
      description: Update invite template.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InviteTemplateUpdateRequest'
            examples:
              Example:
                value:
                  name: Email Template v1
                  company:
                    name: XYZ Bank
                    logoUrl: https://xyzbank.co/logo.png
                  email:
                    sendEmail: true
                    senderName: XYZ Bank
                    replyAddress: replies@xyz.co
                    subject: Please connect your work account to share your data with us
                    body: Hello {{firstName}}, We are working with our partner, Smile API, so you can easily share your employment and income data to us as a requirement for granting you a loan. It will be a quick process and should take no more than a few minutes of your time.
                  landingPage:
                    header: We are working with our partner, Smile API, so you can easily share your employment and income data to us as a requirement for granting you a loan. It will be a quick process and should take no more than a few minutes of your time.
                    description: Share your employment and income data with us at {{company.name}}
                    button: START NOW
                  successPage:
                    header: The process was successful! Please wait for us to get in touch!
                    description: Thank you for sharing your employment and income data with us at {{company.name}}
                    button: Connect another account
        description: ''
    delete:
      summary: Delete Invite Template
      operationId: delete-invite-template
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InviteTemplateDeleteResponse'
              examples:
                Example:
                  value:
                    code: OK
                    message: Success
                    requestId: 5b79399a-6852-4234-bb0e-ad472648282d
      tags:
      - Invite Templates
      description: Delete invite template.
components:
  schemas:
    InviteTemplate:
      title: InviteTemplate
      x-tags:
      - Invite Templates
      type: object
      description: Template to be used for sending invites.
      x-examples:
        Example:
          id: 17bbf36498de4d68a0d4f86c7b62f69f
          name: Email Template v1
          company:
            name: XYZ Bank
            logoUrl: https://xyzbank.co/logo.png
          email:
            sendEmail: true
            senderName: XYZ Bank
            replyAddress: replies@xyz.co
            subject: Please connect your work account to share your data with us
            body: Hello ${firstName}! We are working with our partner, Smile API, so you can easily share your employment and income data to us as a requirement for providing you service. It will be a quick process and should take no more than a few seconds of your time.
          landingPage:
            header: Share your employment and income data with us at ${companyName}
            description: We are working with our partner, Smile API, so you can easily share your employment and income data to us as a requirement for providing you service. It will be a quick process and should take no more than a few seconds of your time.
            button: START NOW
          successPage:
            header: Thank you for sharing your employment and income data with us at ${companyName}
            description: The process was successful! Please wait for us to get in touch!
            button: Connect another account
      properties:
        id:
          $ref: '#/components/schemas/RefObjectID'
        name:
          type: string
          description: Template name
          example: Email Template v1
        company:
          type: object
          required:
          - name
          - logoUrl
          properties:
            name:
              type: string
              example: XYZ Bank
              description: Company name that it will appear in the invite landing page and any invitation message
            logoUrl:
              type: string
              example: https://xyzbank.co/logo.png
              description: Company logo that will appear in the invite email and landing page
        email:
          type: object
          required:
          - sendEmail
          - senderName
          - replyAddress
          - subject
          - body
          properties:
            sendEmail:
              type: boolean
              description: 'Send email using this template (boolean value: true/false)'
            senderName:
              type: string
              description: Sender name that it will appear in the email message
              example: XYZ Bank
            replyAddress:
              type: string
              description: Reply-to address that will be shown when replying to an invite email
              example: replies@xyz.co
              format: email
            subject:
              type: string
              description: Subject that it will appear in the email message
              example: Please connect your work account to share your data with us
            body:
              type: string
              description: Text that it will appear in email message
              example: Hello ${firstName}! We are working with our partner, Smile API, so you can easily share your employment and income data to us as a requirement for giving you service. It will be a quick process and should take no more than a few seconds of your time.
        landingPage:
          type: object
          required:
          - header
          - description
          - button
          properties:
            header:
              type: string
              description: Header text that will appear in the landing page
              example: Share your employment and income data with us at ${companyName}
            description:
              type: string
              description: Description of the landing page
              example: We are working with our partner, Smile API, so you can easily share your employment and income data to us as a requirement for giving you service. It will be a quick process and should take no more than a few seconds of your time.
            button:
              type: string
              description: Text that it will appear in the landing page
              example: START NOW
        successPage:
          type: object
          required:
          - header
          - description
          - button
          properties:
            header:
              type: string
              description: Header text that will appear in the success page
              example: Thank you for sharing your employment and income data with us at ${companyName}
            description:
              type: string
              description: Description of the success page after an account has been linked or data has been uploaded
              example: The process was successful! Please wait for us to get in touch!
            button:
              type: string
              description: Text that it will appear in the landing page
              example: Connect another account
      required:
      - id
      - name
      - company
      - email
      - landingPage
      - successPage
    InviteTemplateGetResponse:
      title: InviteTemplateGetResponse
      type: object
      properties:
        code:
          $ref: '#/components/schemas/ObjectMetadataRefCode'
        message:
          $ref: '#/components/schemas/ObjectMetadataRefMessage'
        requestId:
          $ref: '#/components/schemas/ObjectMetadataRefRequestID'
        data:
          $ref: '#/components/schemas/InviteTemplate'
    InviteTemplatePostRequest:
      type: object
      properties:
        name:
          type: string
          description: Template name
          example: Email Template v1
          minLength: 1
          maxLength: 64
        company:
          type: object
          required:
          - name
          - logoUrl
          properties:
            name:
              type: string
              minLength: 1
              maxLength: 200
              example: XYZ Bank
              description: Company name that it will appear in the invite landing page and email or sms message
            logoUrl:
              type: string
              minLength: 1
              maxLength: 200
              example: https://xyzbank.co/logo.png
              description: Company logo that will appear in the invite email and landing page
        email:
          type: object
          required:
          - sendEmail
          - senderName
          - replyAddress
          - subject
          - body
          properties:
            sendEmail:
              type: boolean
              description: 'Send email using this template (boolean value: true/false)'
            senderName:
              type: string
              minLength: 1
              maxLength: 200
              description: Sender name that it will appear in the email message
              example: XYZ Bank
            replyAddress:
              type: string
              minLength: 1
              maxLength: 200
              description: Reply-to address that will be shown when replying to an invite email
              example: replies@xyz.co
              format: email
            subject:
              type: string
              minLength: 1
              maxLength: 200
              description: Subject that it will appear in the email message
              example: Please connect your work account to share your data with us
            body:
              type: string
              minLength: 1
              maxLength: 5000
              description: Text that it will appear in email message
              example: Hello ${firstName}, We are working with our partner, Smile API, so you can easily share your employment and income data to us as a requirement for giving you service. It will be a quick process and should take no more than a few seconds of your time.
        landingPage:
          type: object
          required:
          - header
          - description
          - button
          properties:
            header:
              type: string
              minLength: 1
              maxLength: 200
              description: Header text that will appear in the landing page
              example: We are working with our partner, Smile API, so you can easily share your employment and income data to us as a requirement for giving you service. It will be a quick process and should take no more than a few seconds of your time.
            description:
              type: string
              minLength: 1
              maxLength: 5000
              description: Description of the landing page
              example: Share your employment and income data with us at ${companyName}
            button:
              type: string
              minLength: 1
              maxLength: 200
              description: Text that it will appear in the landing page
              example: START NOW
        successPage:
          type: object
          required:
          - header
          - description
          - button
          properties:
            header:
              type: string
              minLength: 1
              maxLength: 200
              description: Header text that will appear in the success page
              example: The process was successful! Please wait for us to get in touch!
            description:
              type: string
              minLength: 1
              maxLength: 5000
              description: Description of the success page after an account has been linked or data has been uploaded
              example: Thank you for sharing your employment and income data with us at ${companyName}
            button:
              type: string
              minLength: 1
              maxLength: 200
              description: Text that it will appear in the landing page
              example: Connect another account
      required:
      - name
      - company
      - email
      - landingPage
      - successPage
      title: InviteTemplatePostRequest
      description: ''
    InviteTemplateListResponse:
      title: InviteTemplateListResponse
      type: object
      properties:
        code:
          $ref: '#/components/schemas/ObjectMetadataRefCode'
        message:
          $ref: '#/components/schemas/ObjectMetadataRefMessage'
        requestId:
          $ref: '#/components/schemas/ObjectMetadataRefRequestID'
        data:
          type: object
          properties:
            nextCursor:
              $ref: '#/components/schemas/ObjectNextCursor'
            items:
              type: array
              items:
                $ref: '#/components/schemas/InviteTemplate'
    InviteTemplateUpdateRequest:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 64
          description: Template name
          example: Email Template v1
        company:
          type: object
          required:
          - name
          - logoUrl
          properties:
            name:
              type: string
              minLength: 1
              maxLength: 200
              example: XYZ Bank
              description: Company name that it will appear in the invite landing page and email or sms message
            logoUrl:
              type: string
              minLength: 1
              maxLength: 200
              example: https://xyzbank.co/logo.png
              description: Company logo that will appear in the invite email and landing page
        email:
          type: object
          required:
          - sendEmail
          - senderName
          - replyAddress
          - subject
          - body
          properties:
            sendEmail:
              type: boolean
              description: 'Send email using this template (boolean value: true/false)'
            senderName:
              type: string
              minLength: 1
              maxLength: 200
              description: Sender name that it will appear in the email message
              example: XYZ Bank
            replyAddress:
              type: string
              minLength: 1
              maxLength: 200
              description: Reply-to address that will be shown when replying to an invite email
              example: replies@xyz.co
              format: email
            subject:
              type: string
              minLength: 1
              maxLength: 200
              description: Subject that it will appear in the email message
              example: Please connect your work account to share your data with us
            body:
              type: string
              minLength: 1
              maxLength: 5000
              description: Text that it will appear in email message
              example: Hello ${firstName}, We are working with our partner, Smile API, so you can easily share your employment and income data to us as a requirement for granting you a loan. It will be a quick process and should take no more than a few minutes of your time.
        landingPage:
          type: object
          required:
          - header
          - description
          - button
          properties:
            header:
              type: string
              minLength: 1
              maxLength: 200
              description: Header text that will appear in the landing page
              example: We are working with our partner, Smile API, so you can easily share your employment and income data to us as a requirement for granting you a loan. It will be a quick process and should take no more than a few minutes of your time.
            description:
              type: string
              minLength: 1
              maxLength: 5000
              description: Description of the landing page
              example: Share your employment and income data with us at ${companyName}
            button:
              type: string
              minLength: 1
              maxLength: 200
              description: Text that it will appear in the landing page
              example: START NOW
        successPage:
          type: object
          required:
          - header
          - description
          - button
          properties:
            header:
              type: string
              minLength: 1
              maxLength: 200
              description: Header text that will appear in the success page
              example: The process was successful! Please wait for us to get in touch!
            description:
              type: string
              minLength: 1
              maxLength: 5000
              description: Description of the success page after an account has been linked or data has been uploaded
              example: Thank you for sharing your employment and income data with us at ${companyName}
            button:
              type: string
              minLength: 1
              maxLength: 200
              description: Text that it will appear in the landing page
              example: Connect another account
      required:
      - name
      - company
      - email
      - landingPage
      - successPage
      title: InviteTemplateUpdateRequest
      description: ''
    ObjectNextCursor:
      title: ObjectNextCursor
      type: string
      example: '1259723474'
      description: The next cursor value that can be used in the following query.
      x-internal: false
    RefObjectID:
      type: string
      title: Object ID
      description: Unique ID of this object
      example: 17bbf36498de4d68a0d4f86c7b62f69f
    InviteTemplatePostResponse:
      title: InviteTemplatePostResponse
      type: object
      properties:
        code:
          $ref: '#/components/schemas/ObjectMetadataRefCode'
        message:
          $ref: '#/components/schemas/ObjectMetadataRefMessage'
        requestId:
          $ref: '#/components/schemas/ObjectMetadataRefRequestID'
        data:
          $ref: '#/components/schemas/InviteTemplate'
    InviteTemplateDeleteResponse:
      title: InviteTemplateDeleteResponse
      type: object
      properties:
        code:
          $ref: '#/components/schemas/ObjectMetadataRefCode'
        message:
          $ref: '#/components/schemas/ObjectMetadataRefMessage'
        requestId:
          $ref: '#/components/schemas/ObjectMetadataRefRequestID'
      description: ''
    ObjectMetadataRefCode:
      type: string
      title: ObjectMetadataRefCode
      description: Request status code
      enum:
      - OK
      - CREATED
      - INVALID_CREDENTIALS
      - INVALID_PARAMETERS
      - INVALID_TOKEN
      - UNAUTHORIZED_ACCESS
      - MISSING_RESOURCE
      - REQUEST_LIMIT_EXCEEDED
      - SERVER_ERROR
      - UNSUPPORTED_METHOD
      - SERVER_UNAVAILABLE
      - TIME_LIMIT_EXCEEDED
      example: OK
      x-internal: false
    ObjectMetadataRefMessage:
      type: string
      title: ObjectMetadataRefMessage
      description: Message response to the request
      example: Success
      x-internal: false
    ObjectMetadataRefRequestID:
      type: string
      title: ObjectMetadataRefRequestID
      description: Unique ID that is added to the body of every response for easy traceability of the request in our logs.
      x-internal: false
      example: 5b79399a-6852-4234-bb0e-ad472648282d
    InviteTemplateUpdateResponse:
      title: InviteTemplateUpdateResponse
      type: object
      properties:
        code:
          $ref: '#/components/schemas/ObjectMetadataRefCode'
        message:
          $ref: '#/components/schemas/ObjectMetadataRefMessage'
        requestId:
          $ref: '#/components/schemas/ObjectMetadataRefRequestID'
        data:
          $ref: '#/components/schemas/InviteTemplate'
      description: ''
  parameters:
    id:
      name: id
      in: path
      schema:
        type: string
        minLength: 1
        maxLength: 200
      description: ID of the specific object in the collection.
      required: true
    cursor:
      name: cursor
      in: query
      required: false
      schema:
        type: string
      description: Uses the filter values of the previous page to determine the next set of items.
    size:
      name: size
      in: query
      schema:
        type: integer
        example: 50
        minimum: 1
        maximum: 150
        default: 10
      description: The number of objects you want returned in a collection.
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
x-provenance:
  method: searched
  source: https://docs.getsmileapi.com/reference
  harvested: '2026-10-20'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.getsmileapi.com/reference/create-alpha-blacklist.md
  - https://docs.getsmileapi.com/reference/create-alpha-footprint.md
  - https://docs.getsmileapi.com/reference/create-alpha-income-estimator.md
  - https://docs.getsmileapi.com/reference/create-alpha-maw.md
  - https://docs.getsmileapi.com/reference/create-alpha-signal.md
  - https://docs.getsmileapi.com/reference/create-and-classify-archive.md
  - https://docs.getsmileapi.com/reference/create-archive.md


# --- truncated at 32 KB (37 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/getsmileapi/refs/heads/main/openapi/getsmileapi-invite-templates-api-openapi.yml