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/getoneprofile-ai:getoneprofile-ai-onboarding-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

openapi: 3.2.0
info:
  contact:
    email: support@getoneprofile.ai
    name: Oneprofile Support
  description: REST API reference for Oneprofile, the GTM data layer for your CRM. Manage tables, enrichments, and integrations. Authenticate with an API key to get started.
  termsOfService: https://www.getoneprofile.ai/terms
  title: Reference | Oneprofile Onboarding API
  version: 1.0.42765316646
tags:
- description: 'The Getting started checklist: a workspace''s progress through the six steps from its first people search to its first launched sequence.'
  name: Onboarding
paths:
  /onboarding/:
    get:
      description: 'Get the organization''s Getting started checklist as its last sync left it: six steps from the first people search to the first launched sequence, and what the pending steps link to today. Reading changes nothing. `POST /onboarding/sync/` starts the checklist and ticks the steps the workspace has done; the dashboard syncs as it opens, and progress is also brought up to date daily.'
      operationId: get_onboarding
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnboardingReadSchema'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenResponse'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundResponse'
          description: Nobody has opened the workspace yet, so it has no checklist.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityResponse'
          description: Invalid request made to the API.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Internal server error.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Bad gateway error.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Service unavailable.
      security:
      - APIKeyHeader: []
      - HTTPBearer: []
      summary: Get the Getting started checklist
      tags:
      - Onboarding
    patch:
      description: Hide the checklist widget for the whole organization. Idempotent. The checklist stays readable and keeps tracking progress; only the sidebar stops showing it.
      operationId: dismiss_onboarding
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OnboardingUpdateSchema'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnboardingReadSchema'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenResponse'
          description: Forbidden
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityResponse'
          description: Invalid request made to the API.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Internal server error.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Bad gateway error.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Service unavailable.
      security:
      - APIKeyHeader: []
      - HTTPBearer: []
      summary: Hide the Getting started checklist
      tags:
      - Onboarding
  /onboarding/sync/:
    post:
      description: Check the workspace for what the pending steps of the Getting started checklist ask for, complete the ones it finds and answer the checklist, so progress is right whether a step was done in the dashboard, through the API or from the Chrome extension. The first sync creates the checklist, and when the person calling made the workspace it also starts writing the business context from their company website. The dashboard calls this as it opens.
      operationId: sync_onboarding
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnboardingReadSchema'
          description: Successful Response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedResponse'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenResponse'
          description: Forbidden
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityResponse'
          description: Invalid request made to the API.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Internal server error.
        '502':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Bad gateway error.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerErrorResponse'
          description: Service unavailable.
      security:
      - APIKeyHeader: []
      - HTTPBearer: []
      summary: Bring the Getting started checklist up to date
      tags:
      - Onboarding
components:
  schemas:
    ForbiddenResponse:
      properties:
        detail:
          description: The detail of why the request is forbidden.
          title: Detail
          type: string
      required:
      - detail
      title: ForbiddenResponse
      type: object
    UnprocessableEntityIssue:
      properties:
        input:
          anyOf:
          - type: string
          - type: integer
          - type: number
          - type: boolean
          - items: {}
            type: array
          - additionalProperties: true
            type: object
          description: The user's input that caused the error.
          title: Input
        loc:
          description: The location of the error. Always contains 1 or 2 elements. The first element is the type of location (e.g. 'body', 'query', 'path', 'header'). The second element is the name of the field that caused the error. If the error is not related to a specific field, the second element is not present.
          items:
            type: string
          title: Loc
          type: array
        msg:
          description: The message of the error. The error message to show to the user.
          title: Msg
          type: string
        type:
          description: The type of the error. Useful for frontend code to handle different types of errors.
          title: Type
          type: string
      required:
      - loc
      - msg
      - type
      - input
      title: UnprocessableEntityIssue
      type: object
    ServerErrorResponse:
      properties:
        detail:
          description: The detail of why the server returned an error.
          title: Detail
          type: string
      required:
      - detail
      title: ServerErrorResponse
      type: object
    OnboardingItemReadSchema:
      properties:
        completed_at:
          anyOf:
          - format: date-time
            type: string
          - type: 'null'
          title: Completed At
        id:
          format: uuid
          title: Id
          type: string
        sort_order:
          title: Sort Order
          type: integer
        step_key:
          $ref: '#/components/schemas/OnboardingStepKey'
      required:
      - id
      - step_key
      - sort_order
      - completed_at
      title: OnboardingItemReadSchema
      type: object
    OnboardingTargetsReadSchema:
      description: Where the pending steps deep-link; every field is null once the checklist is done.
      properties:
        draft_sequence_id:
          anyOf:
          - format: uuid
            type: string
          - type: 'null'
          description: A draft sequence waiting to be launched; null when there is none.
          title: Draft Sequence Id
        latest_table_id:
          anyOf:
          - format: uuid
            type: string
          - type: 'null'
          description: The newest table, for the add-column steps; null when there is none yet.
          title: Latest Table Id
        sender_profile_id:
          anyOf:
          - format: uuid
            type: string
          - type: 'null'
          description: 'The sender whose LinkedIn tab the connect step opens: one that already sends email when there is one; null when the workspace has no sender.'
          title: Sender Profile Id
      required:
      - latest_table_id
      - sender_profile_id
      - draft_sequence_id
      title: OnboardingTargetsReadSchema
      type: object
    OnboardingReadSchema:
      properties:
        completed_at:
          anyOf:
          - format: date-time
            type: string
          - type: 'null'
          description: When the last step was completed; null while any step is pending.
          title: Completed At
        created_at:
          format: date-time
          title: Created At
          type: string
        dismissed_at:
          anyOf:
          - format: date-time
            type: string
          - type: 'null'
          description: When someone hid the checklist for the workspace; null while it shows.
          title: Dismissed At
        id:
          format: uuid
          title: Id
          type: string
        items:
          description: The steps, in checklist order.
          items:
            $ref: '#/components/schemas/OnboardingItemReadSchema'
          title: Items
          type: array
        targets:
          $ref: '#/components/schemas/OnboardingTargetsReadSchema'
        updated_at:
          format: date-time
          title: Updated At
          type: string
      required:
      - id
      - completed_at
      - dismissed_at
      - items
      - targets
      - created_at
      - updated_at
      title: OnboardingReadSchema
      type: object
    OnboardingStepKey:
      description: 'The six steps a new workspace is walked through, named by outcome.


        Stored as a plain string column, so a seventh step is a new member here

        plus a row the next read seeds: no enum migration, no backfill.'
      enum:
      - find_leads
      - add_enrichment
      - add_ai_column
      - connect_mailbox
      - connect_linkedin
      - launch_sequence
      title: OnboardingStepKey
      type: string
    OnboardingUpdateSchema:
      description: 'The change a person makes to the checklist: hiding it for the workspace.'
      properties:
        dismissed:
          const: true
          description: 'Send true to hide the checklist for the whole workspace. Hiding is one way: nothing shows the sidebar widget again.'
          title: Dismissed
          type: boolean
      required:
      - dismissed
      title: OnboardingUpdateSchema
      type: object
    UnprocessableEntityResponse:
      properties:
        detail:
          description: The detail of the error. This is the error message to show to the user. You should also use the issues field to show more detailed error messages per field. Use this field for a single liner error message.
          title: Detail
          type: string
        issues:
          description: The issues that caused the error. There can be multiple issues. Each issue is a user-facing error message.
          items:
            $ref: '#/components/schemas/UnprocessableEntityIssue'
          title: Issues
          type: array
      required:
      - detail
      - issues
      title: UnprocessableEntityResponse
      type: object
    UnauthorizedResponse:
      properties:
        detail:
          description: The detail of why the request is unauthorized.
          title: Detail
          type: string
      required:
      - detail
      title: UnauthorizedResponse
      type: object
    NotFoundResponse:
      properties:
        detail:
          description: The detail of why the resource was not found.
          title: Detail
          type: string
      required:
      - detail
      title: NotFoundResponse
      type: object
  securitySchemes:
    APIKeyHeader:
      in: header
      name: X-API-Key
      type: apiKey
    HTTPBearer:
      scheme: bearer
      type: http