Laurel

Laurel Onboarding Profiles API

The Onboarding Profiles API from Laurel — 3 operation(s) for onboarding profiles.

Documentation GitHub OpenAPI

Operations 5

POST /api/v1/onboarding-profiles Create onboarding profile for current user #

GET /api/v1/onboarding-profiles/{userId} Get onboarding profile by user id #

PATCH /api/v1/onboarding-profiles/{userId} Update onboarding profile #

DELETE /api/v1/onboarding-profiles/{userId} Delete onboarding profile by user id #

PATCH /api/v1/onboarding-profiles/{userId}/steps/{stepId} Update individual onboarding step #

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/laurel-onboarding-profiles-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: Identity Service Onboarding Profiles API
  description: ''
  version: '1'
  contact: {}
servers: []
security:
- ApiBearerAuth: []
tags:
- name: Onboarding Profiles
paths:
  /api/v1/onboarding-profiles:
    post:
      operationId: OnboardingProfileController_createOnboardingProfile_v1
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOnboardingProfileDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnboardingProfile'
      summary: Create onboarding profile for current user
      tags:
      - Onboarding Profiles
  /api/v1/onboarding-profiles/{userId}:
    get:
      operationId: OnboardingProfileController_getOnboardingProfile_v1
      parameters:
      - name: userId
        required: true
        in: path
        description: user's id
        schema:
          format: objectid
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnboardingProfile'
      summary: Get onboarding profile by user id
      tags:
      - Onboarding Profiles
    patch:
      operationId: OnboardingProfileController_updateOnboardingProfile_v1
      parameters:
      - name: userId
        required: true
        in: path
        description: user's id
        schema:
          format: objectid
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOnboardingProfileDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnboardingProfile'
      summary: Update onboarding profile
      tags:
      - Onboarding Profiles
    delete:
      operationId: OnboardingProfileController_deleteOnboardingProfile_v1
      parameters:
      - name: userId
        required: true
        in: path
        description: user's id
        schema:
          format: objectid
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnboardingProfile'
      summary: Delete onboarding profile by user id
      tags:
      - Onboarding Profiles
  /api/v1/onboarding-profiles/{userId}/steps/{stepId}:
    patch:
      operationId: OnboardingProfileController_updateOnboardingStep_v1
      parameters:
      - name: userId
        required: true
        in: path
        description: user's id
        schema:
          format: objectid
          type: string
      - name: stepId
        required: true
        in: path
        description: onboarding step id
        schema:
          type: string
          enum:
          - LANGUAGE
          - TIMEKEEPING_PREFERENCE
          - WELCOME_VIDEO
          - PRIVACY
          - WALKTHROUGH
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOnboardingStepDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnboardingProfile'
      summary: Update individual onboarding step
      tags:
      - Onboarding Profiles
components:
  schemas:
    UpdatePrivacyStepSkippedDto:
      type: object
      properties:
        stepType:
          type: string
          enum:
          - PRIVACY
        skippedAt:
          type: string
          example: '2022-08-12T20:44:48Z'
          format: iso-date-time
      required:
      - stepType
      - skippedAt
    UpdateOnboardingStepDto:
      type: object
      properties:
        step:
          description: step update data
          oneOf:
          - $ref: '#/components/schemas/UpdateBaseStepDto'
          - $ref: '#/components/schemas/UpdatePrivacyStepDto'
          - $ref: '#/components/schemas/UpdatePrivacyStepSkippedDto'
      required:
      - step
    PrivacyStepSkippedRecord:
      type: object
      properties:
        skippedAt:
          type: string
          example: '2022-08-12T20:44:48Z'
          format: iso-date-time
      required:
      - skippedAt
    StepRecordBase:
      type: object
      properties:
        completedAt:
          type:
          - string
          - 'null'
          example: '2022-08-12T20:44:48Z'
          format: iso-date-time
        skippedAt:
          type:
          - string
          - 'null'
          example: '2022-08-12T20:44:48Z'
          format: iso-date-time
    OnboardingProfile:
      type: object
      properties:
        _id:
          type: string
          format: objectid
        userId:
          type: string
          format: objectid
        customerId:
          type: string
          format: objectid
        timekeepingSinceYear:
          type:
          - number
          - 'null'
          format: double
        timekeepingFrequency:
          type:
          - string
          - 'null'
          enum:
          - DAILY
          - FEW_PER_WEEK
          - WEEKLY
          - MONTHLY
          - OTHER
        usesTimers:
          type:
          - boolean
          - 'null'
          deprecated: true
        timerFrequency:
          type:
          - string
          - 'null'
          enum:
          - ALWAYS
          - SOMETIMES
          - NEVER
        avgInitiativesPerDay:
          type:
          - number
          - 'null'
          format: double
        steps:
          type:
          - object
          - 'null'
          allOf:
          - $ref: '#/components/schemas/OnboardingSteps'
        completedAt:
          type:
          - string
          - 'null'
          example: '2022-08-12T20:44:48Z'
          format: iso-date-time
        createdAt:
          type: string
          example: '2022-08-12T20:44:48Z'
          format: iso-date-time
        updatedAt:
          type: string
          example: '2022-08-12T20:44:48Z'
          format: iso-date-time
      required:
      - _id
      - userId
      - customerId
      - createdAt
      - updatedAt
    UpdatePrivacyStepDto:
      type: object
      properties:
        stepType:
          type: string
          description: step identifier
          enum:
          - PRIVACY
        acceptedAt:
          type: string
          description: privacy acceptance timestamp
          example: '2022-08-12T20:44:48Z'
          format: iso-date-time
        docId:
          type: string
          description: privacy document id
          format: objectid
        language:
          type: string
          description: language of privacy document
        versionId:
          type: string
          description: version of privacy document
          format: objectid
      required:
      - stepType
      - acceptedAt
      - docId
      - language
      - versionId
    PrivacyStepRecord:
      type: object
      properties:
        acceptedAt:
          type: string
          example: '2022-08-12T20:44:48Z'
          format: iso-date-time
        docId:
          type: string
          format: objectid
        language:
          type: string
        versionId:
          type: string
          format: objectid
      required:
      - acceptedAt
      - docId
      - language
      - versionId
    UpdateBaseStepDto:
      type: object
      properties:
        stepType:
          type: string
          description: step identifier
          enum:
          - LANGUAGE
          - TIMEKEEPING_PREFERENCE
          - WELCOME_VIDEO
          - WALKTHROUGH
        completedAt:
          type:
          - string
          - 'null'
          description: if set, marks step as completed at this time
          example: '2022-08-12T20:44:48Z'
          format: iso-date-time
        skippedAt:
          type:
          - string
          - 'null'
          description: if set, marks step as skipped at this time
          example: '2022-08-12T20:44:48Z'
          format: iso-date-time
      required:
      - stepType
    UpdateOnboardingProfileDto:
      type: object
      properties:
        timekeepingSinceYear:
          type:
          - number
          - 'null'
          description: if set, updates year since user has been timekeeping
          format: double
        timekeepingFrequency:
          description: if set, updates how frequently user does timekeeping
          allOf:
          - $ref: '#/components/schemas/TimekeepingFrequency'
        usesTimers:
          type:
          - boolean
          - 'null'
          deprecated: true
        timerFrequency:
          description: if set, updates how frequently user uses timers
          allOf:
          - $ref: '#/components/schemas/TimerFrequency'
        avgInitiativesPerDay:
          type:
          - number
          - 'null'
          description: if set, updates average number of initiatives user works on per day
          format: double
    OnboardingSteps:
      type: object
      properties:
        LANGUAGE:
          type:
          - object
          - 'null'
          allOf:
          - $ref: '#/components/schemas/StepRecordBase'
        TIMEKEEPING_PREFERENCE:
          type:
          - object
          - 'null'
          allOf:
          - $ref: '#/components/schemas/StepRecordBase'
        WELCOME_VIDEO:
          type:
          - object
          - 'null'
          allOf:
          - $ref: '#/components/schemas/StepRecordBase'
        PRIVACY:
          oneOf:
          - $ref: '#/components/schemas/PrivacyStepRecord'
          - $ref: '#/components/schemas/PrivacyStepSkippedRecord'
        WALKTHROUGH:
          type:
          - object
          - 'null'
          allOf:
          - $ref: '#/components/schemas/StepRecordBase'
    CreateOnboardingProfileDto:
      type: object
      properties:
        timekeepingSinceYear:
          type:
          - number
          - 'null'
          description: year since user has been timekeeping
          format: double
        timekeepingFrequency:
          type:
          - string
          - 'null'
          description: how frequently user does timekeeping
          enum:
          - DAILY
          - FEW_PER_WEEK
          - WEEKLY
          - MONTHLY
          - OTHER
        usesTimers:
          type:
          - boolean
          - 'null'
          deprecated: true
        timerFrequency:
          type:
          - string
          - 'null'
          description: how frequently user uses timers
          enum:
          - ALWAYS
          - SOMETIMES
          - NEVER
        avgInitiativesPerDay:
          type:
          - number
          - 'null'
          description: average number of initiatives user works on per day
          format: double
    TimekeepingFrequency:
      type: string
      enum:
      - DAILY
      - FEW_PER_WEEK
      - WEEKLY
      - MONTHLY
      - OTHER
      description: if set, updates how frequently user does timekeeping
    TimerFrequency:
      type: string
      enum:
      - ALWAYS
      - SOMETIMES
      - NEVER
      description: if set, updates how frequently user uses timers
  securitySchemes:
    ApiBearerAuth:
      scheme: bearer
      bearerFormat: JWT
      description: Enter access token
      type: http
externalDocs:
  description: Laurel API Documentation
  url: https://developer.laurel.ai/