Smile

Smile Invites API

The Invites API from Smile — 3 operation(s) for invites.

GitHub OpenAPI

Operations 4

GET /invites List Invites #
POST /invites Create Invite #
GET /invites/{id} View Invite #
GET /invites/{inviteId}/logs List Invite Logs #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/getsmileapi/openapi/getsmileapi-invites-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/getsmileapi/json-schema/getsmileapi-invite-post-request-schema.json

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/getsmileapi:getsmileapi-invites-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

getsmileapi-invites-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Smile Invites 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: Invites
paths:
  /invites:
    get:
      summary: List Invites
      tags:
      - Invites
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InviteListResponse'
              examples:
                Example:
                  value:
                    code: OK
                    message: Success
                    requestId: 5b79399a-6852-4234-bb0e-ad472648282d
                    data:
                      nextCursor: '1259723474'
                      items:
                      - id: 17bbf36498de4d68a0d4f86c7b62f69f
                        createdAt: '2021-04-14T09:30:24Z'
                        fullName: George Cimafranca Palomero, Jr
                        firstName: George
                        lastName: Palomero
                        email: gpalomero1234@smileapi.io
                        templateId: tpl-b2c5e816-65ad-4130-819d-db89acc5869a
                        winkTemplateId: wtpl-db89acc5869a-b2c5e816-65ad-4130-819d
                        userId: tenantId-b2c5e816-65ad-4130-819d-db89acc5869a
                        status: INVITED
                        updatedAt: '2021-04-14T09:30:24Z'
                        invitedAt: '2021-04-14T09:30:24Z'
                        linkedAt: '2021-04-14T09:30:24Z'
                        inviteLandingPageUrl: https://user.getsmileapi.com/invite-user/xx-xxxxxx?token=xxxxxxxxx
      operationId: list-invites
      description: List the list of invites sent out to users.
      parameters:
      - $ref: '#/components/parameters/size'
      - $ref: '#/components/parameters/cursor'
    post:
      summary: Create Invite
      operationId: create-invite
      responses:
        '201':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvitePostResponse'
              examples:
                Example:
                  value:
                    code: OK
                    message: Success
                    requestId: 5b79399a-6852-4234-bb0e-ad472648282d
                    data:
                      id: 17bbf36498de4d68a0d4f86c7b62f69f
                      createdAt: '2021-04-14T09:30:24Z'
                      fullName: George Cimafranca Palomero, Jr
                      firstName: George
                      lastName: Palomero
                      email: gpalomero1234@smileapi.io
                      templateId: tpl-b2c5e816-65ad-4130-819d-db89acc5869a
                      winkTemplateId: wtpl-db89acc5869a-b2c5e816-65ad-4130-819d
                      userId: tenantId-b2c5e816-65ad-4130-819d-db89acc5869a
                      status: INVITED
                      updatedAt: '2021-04-14T09:30:24Z'
                      invitedAt: '2021-04-14T09:30:24Z'
                      linkedAt: '2021-04-14T09:30:24Z'
                      inviteLandingPageUrl: https://user.getsmileapi.com/invite-user/xx-xxxxxx?token=xxxxxxxxx
      description: Create and send an invite to a user
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InvitePostRequest'
            examples:
              Example:
                value:
                  fullName: Ryan Joseph Peterson Chua Ng
                  firstName: Ryan
                  lastName: Ng
                  email: ryan1234@smileapi.io
                  templateId: tpl-b2c5e81665ad4130819ddb89acc5869a
                  winkTemplateId: wtpl-db89acc5869a-b2c5e816-65ad-4130-819d
      tags:
      - Invites
  /invites/{id}:
    parameters:
    - $ref: '#/components/parameters/id'
    get:
      summary: View Invite
      tags:
      - Invites
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InviteGetResponse'
              examples:
                Example:
                  value:
                    code: OK
                    message: Success
                    requestId: 5b79399a-6852-4234-bb0e-ad472648282d
                    data:
                      id: 17bbf36498de4d68a0d4f86c7b62f69f
                      createdAt: '2021-04-14T09:30:24Z'
                      fullName: George Cimafranca Palomero, Jr
                      firstName: George
                      lastName: Palomero
                      email: gpalomero1234@smileapi.io
                      templateId: tpl-b2c5e816-65ad-4130-819d-db89acc5869a
                      winkTemplateId: wtpl-db89acc5869a-b2c5e816-65ad-4130-819d
                      userId: tenantId-b2c5e816-65ad-4130-819d-db89acc5869a
                      status: INVITED
                      updatedAt: '2021-04-14T09:30:24Z'
                      invitedAt: '2021-04-14T09:30:24Z'
                      linkedAt: '2021-04-14T09:30:24Z'
                      inviteLandingPageUrl: https://user.getsmileapi.com/invite-user/xx-xxxxxx?token=xxxxxxxxx
      operationId: get-invite
      description: View invite sent to users by ID.
  /invites/{inviteId}/logs:
    parameters:
    - name: inviteId
      in: path
      schema:
        type: string
        minLength: 1
        maxLength: 200
      description: ID of the specific invite in the collection.
      required: true
    get:
      summary: List Invite Logs
      tags:
      - Invites
      parameters:
      - $ref: '#/components/parameters/size'
      - $ref: '#/components/parameters/cursor'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InviteLogListResponse'
              examples:
                Example:
                  value:
                    code: OK
                    message: Success
                    requestId: 5b79399a-6852-4234-bb0e-ad472648282d
                    data:
                      nextCursor: null
                      items:
                      - id: invl-b2c5e816-65ad-4130-819d-db89acc5869a
                        inviteId: inv-b2c5e816-65ad-4130-819d-db89acc5869a
                        createdAt: '2021-04-14T09:30:24Z'
                        inviteStatus: INVITED
                        userId: tenant-17bbf36498de4d68a0d4f86c7b62f69f
      operationId: list-invite-log
      description: List invite log.
components:
  schemas:
    InviteLogListResponse:
      title: InviteLogListResponse
      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/InviteLog'
      x-examples: {}
    InviteStatus:
      type: string
      enum:
      - INVITED
      - EMAIL_OPENED
      - LANDING_PAGE_OPENED
      - WINK_WIDGET_OPENED
      - LINKED
      - REVOKED
      description: Status of the invite
    InviteListResponse:
      title: InviteListResponse
      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/Invite'
      x-examples: {}
    InviteGetResponse:
      title: InviteGetResponse
      type: object
      properties:
        code:
          $ref: '#/components/schemas/ObjectMetadataRefCode'
        message:
          $ref: '#/components/schemas/ObjectMetadataRefMessage'
        requestId:
          $ref: '#/components/schemas/ObjectMetadataRefRequestID'
        data:
          $ref: '#/components/schemas/Invite'
    ObjectNextCursor:
      title: ObjectNextCursor
      type: string
      example: '1259723474'
      description: The next cursor value that can be used in the following query.
      x-internal: false
    Invite:
      title: Invite
      type: object
      description: Invitation for a user to share their data.
      x-tags:
      - Invites
      x-examples:
        Example:
          id: inv-b2c5e816-65ad-4130-819d-db89acc5869a
          createdAt: '2021-04-14T09:30:24Z'
          fullName: George Cimafranca Palomero, Jr
          firstName: George
          lastName: Palomero
          email: gpalomero1234@smileapi.io
          templateId: tpl-b2c5e816-65ad-4130-819d-db89acc5869a
          winkTemplateId: wtpl-db89acc5869a-b2c5e816-65ad-4130-819d
          userId: tenant-17bbf36498de4d68a0d4f86c7b62f69f
          status: INVITED
          updatedAt: '2021-04-14T09:30:24Z'
          invitedAt: '2021-04-14T09:30:24Z'
          linkedAt: '2021-04-14T09:30:24Z'
          inviteLandingPageUrl: https://user.getsmileapi.com/invite-user/xx-xxxxxx?token=xxxxxxxxx
      properties:
        id:
          $ref: '#/components/schemas/RefObjectID'
        createdAt:
          $ref: '#/components/schemas/RefDateTime'
        fullName:
          type: string
          example: George Cimafranca Palomero, Jr
          description: The full name of the invited user
        firstName:
          type: string
          example: George
          description: The first name of the invited user
        lastName:
          type: string
          example: Palomero
          description: The last name of the invited user
        email:
          example: gpalomero1234@smileapi.io
          description: The email address of the invited user
          format: email
          type: string
        templateId:
          type: string
          description: The template ID used in the invitation
          example: tpl-b2c5e816-65ad-4130-819d-db89acc5869a
        winkTemplateId:
          type: string
          description: The Wink template ID used in the invitation
          example: wtpl-db89acc5869a-b2c5e816-65ad-4130-819d
        userId:
          type: string
          description: The user ID for this invitation
          example: tenantId-b2c5e816-65ad-4130-819d-db89acc5869a
        status:
          $ref: '#/components/schemas/InviteStatus'
        updatedAt:
          $ref: '#/components/schemas/RefDateTime'
        invitedAt:
          $ref: '#/components/schemas/RefDateTime'
        linkedAt:
          $ref: '#/components/schemas/RefDateTime'
        inviteLandingPageUrl:
          type: string
          description: URL of the unique landing page for the invited user to connect their accounts
      required:
      - id
      - createdAt
      - fullName
      - email
      - templateId
      - userId
      - status
      - updatedAt
      - invitedAt
      - linkedAt
    InvitePostRequest:
      title: InvitePostRequest
      type: object
      description: ''
      required:
      - email
      - fullName
      - templateId
      properties:
        fullName:
          type: string
          minLength: 1
          maxLength: 200
          example: George Cimafranca Palomero, Jr
          description: The full name of the person to be invited
        firstName:
          type: string
          minLength: 1
          maxLength: 64
          description: The first name of the person to be invited
          example: George
        lastName:
          type: string
          minLength: 1
          maxLength: 64
          description: The last name of the person to be invited
          example: Palomero
        email:
          type: string
          minLength: 1
          maxLength: 200
          example: gpalomero1234@smileapi.io
          description: Email of the person to be invited
          format: email
        templateId:
          type: string
          minLength: 1
          maxLength: 64
          description: The template ID to be used in the invite
          example: tpl-b2c5e816-65ad-4130-819d-db89acc5869a
        winkTemplateId:
          type: string
          minLength: 1
          maxLength: 64
          description: The Wink template ID used in the invitation
          example: wtpl-db89acc5869a-b2c5e816-65ad-4130-819d
    InvitePostResponse:
      title: InvitePostResponse
      type: object
      properties:
        code:
          $ref: '#/components/schemas/ObjectMetadataRefCode'
        message:
          $ref: '#/components/schemas/ObjectMetadataRefMessage'
        requestId:
          $ref: '#/components/schemas/ObjectMetadataRefRequestID'
        data:
          $ref: '#/components/schemas/Invite'
      x-examples: {}
    RefObjectID:
      type: string
      title: Object ID
      description: Unique ID of this object
      example: 17bbf36498de4d68a0d4f86c7b62f69f
    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
    RefDateTime:
      type: string
      title: Date and Time string
      format: date-time
      example: '2021-04-14T09:30:24Z'
      description: Date and time
    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
    InviteLog:
      type: object
      description: Invite status change log
      x-examples:
        Example:
          id: invl-b2c5e816-65ad-4130-819d-db89acc5869a
          inviteId: inv-b2c5e816-65ad-4130-819d-db89acc5869a
          createdAt: '2021-04-14T09:30:24Z'
          inviteStatus: WINK_WIDGET_OPENED
          userId: tenant-17bbf36498de4d68a0d4f86c7b62f69f
      required:
      - id
      - inviteId
      - userId
      - inviteStatus
      - createdAt
      properties:
        id:
          $ref: '#/components/schemas/RefObjectID'
        inviteId:
          type: string
          description: the reference invite ID
        inviteStatus:
          $ref: '#/components/schemas/InviteStatus'
        userId:
          type: string
        createdAt:
          $ref: '#/components/schemas/RefDateTime'
  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
  - https://docs.getsmileapi.com/reference/create-beta-maw2.md
  - https://docs.getsmileapi.com/reference/create-beta-maw3.md
  - https://docs.getsmileapi.com/reference/create-beta-signal.md
  - https://docs.getsmileapi.com/reference/create-beta-signal2.md
  - https://docs.getsmileapi.com/reference/create-beta-signal3.md
  - https://docs.getsmileapi.com/reference/create-beta-social-security.md
  - https://docs.getsmileapi.com/reference/create-consent-template.md
  - https://docs.getsmileapi.com/reference/create-invite-template.md
  - https://docs.getsmileapi.com/reference/create-invite.md
  - https://docs.getsmileapi.com/reference/create-token-1.md
  - https://docs.getsmileapi.com/reference/create-user-1.md
  - https://docs.getsmileapi.com/reference/create-verification.md
  - https://docs.getsmileapi.com/reference/create-webhook.md
  - https://docs.getsmileapi.com/reference/delete-account.md
  - https://docs.getsmileapi.com/reference/delete-archive.md
  - https://docs.getsmileapi.com/reference/delete-consent-template.md
  - https://docs.getsmileapi.com/reference/delete-invite-template.md
  - https://docs.getsmileapi.com/reference/delete-webhook.md
  - https://docs.getsmileapi.com/reference/disable-account-monitor.md
  - https://docs.getsmileapi.com/reference/generate-account-export.md
  - https://docs.getsmileapi.com/reference/get-account-1.md
  - https://docs.getsmileapi.com/reference/get-account-payload.md
  - https://docs.getsmileapi.com/reference/get-alpha-blacklist.md
  - https://docs.getsmileapi.com/reference/get-alpha-footprint.md
  - https://docs.getsmileapi.com/reference/get-alpha-form.md
  - https://docs.getsmileapi.com/reference/get-alpha-income-estimator.md
  - https://docs.getsmileapi.com/reference/get-alpha-maw.md
  - https://docs.getsmileapi.com/reference/get-alpha-signal.md
  - https://docs.getsmileapi.com/reference/get-archive.md
  - https://docs.getsmileapi.com/reference/get-beta-maw.md
  - https://docs.getsmileapi.com/reference/get-beta-signal.md
  - https://docs.getsmileapi.com/reference/get-beta-social-security.md
  - https://docs.getsmileapi.com/reference/get-contribution.md
  - https://docs.getsmileapi.com/reference/get-document-1.md
  - https://docs.getsmileapi.com/reference/get-eincomes.md
  - https://docs.getsmileapi.com/reference/get-employment-1.md
  - https://docs.getsmileapi.com/reference/get-feature-insight.md
  - https://docs.getsmileapi.com/reference/get-identity-1.md
  - https://docs.getsmileapi.com/reference/get-income-1.md
  - https://docs.getsmileapi.com/reference/get-invite-template.md
  - https://docs.getsmileapi.com/reference/get-invite.md
  - https://docs.getsmileapi.com/reference/get-liabilities.md
  - https://docs.getsmileapi.com/reference/get-link.md
  - https://docs.getsmileapi.com/reference/get-provider-1.md
  - https://docs.getsmileapi.com/reference/get-rating-1.md
  - https://docs.getsmileapi.com/reference/get-task.md
  - https://docs.getsmileapi.com/reference/get-transaction-1.md
  - https://docs.getsmileapi.com/reference/get-user-1.md
  - https://docs.getsmileapi.com/reference/get-user-session-payload.md
  - https://docs.getsmileapi.com/reference/get-verification.md
  - https://docs.getsmileapi.com/reference/get-webhook.md
  - https://docs.getsmileapi.com/reference/list-accounts-1.md
  - https://docs.getsmileapi.com/reference/list-alpha-blacklists.md
  - https://docs.getsmileapi.com/reference/list-alpha-footprints.md
  - https://docs.getsmileapi.com/reference/list-alpha-forms.md
  - https://docs.getsmileapi.com/reference/list-alpha-income-estimators.md
  - https://docs.getsmileapi.com/reference/list-alpha-maws.md
  - https://docs.getsmileapi.com/reference/list-alpha-signals.md
  - https://docs.getsmileapi.com/reference/list-archives.md
  - https://docs.getsmileapi.com/reference/list-beta-maws.md
  - https://docs.getsmileapi.com/reference/list-beta-signals.md
  - https://docs.getsmileapi.com/reference/list-beta-social-securities.md
  - https://docs.getsmileapi.com/reference/list-consent-templates.md
  - https://docs.getsmileapi.com/reference/list-contributions.md
  - https://docs.getsmileapi.com/reference/list-documents-1.md
  - https://docs.getsmileapi.com/reference/list-eincomes.md
  - https://docs.getsmileapi.com/reference/list-employments-1.md
  - https://docs.getsmileapi.com/reference/list-file-types.md
  - https://docs.getsmileapi.com/reference/list-identities-1.md
  - https://docs.getsmileapi.com/reference/list-incomes-1.md
  - https://docs.getsmileapi.com/reference/list-insights.md
  - https://docs.getsmileapi.com/reference/list-invite-log.md
  - https://docs.getsmileapi.com/reference/list-invite-templates.md
  - https://docs.getsmileapi.com/reference/list-invites.md
  - https://docs.getsmileapi.com/reference/list-liabilities.md
  - https://docs.getsmileapi.com/reference/list-links.md
  - https://docs.getsmileapi.com/reference/list-providers.md
  - https://docs.getsmileapi.com/reference/list-ratings-1.md
  - https://docs.getsmileapi.com/reference/list-tasks.md
  - https://docs.getsmileapi.com/reference/list-transactions-1.md
  - https://docs.getsmileapi.com/reference/list-users-1.md
  - https://docs.getsmileapi.com/reference/list-verifications.md
  - https://docs.getsmileapi.com/reference/list-webhooks.md
  - https://docs.getsmileapi.com/reference/reset-user-session.md
  - https://docs.getsmileapi.com/reference/update-invite-template.md
  merge:
    pages: 92
    deduped: 1153
    conflicts_kept_first: 0