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/thisisbud:thisisbud-customer-level-insights-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:
  version: 1.0.0
  title: Customer-Level Insights API
  contact:
    name: API Support
    url: https://www.thisisbud.com/support
    email: contact@thisisbud.com
  x-logo:
    url: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAATAAAABuCAQAAAAKAYdLAAAACXBIWXMAAC4jAAAuIwF4pT92AAAAB3RJTUUH4wQDDggcbXcx7wAABeJJREFUeNrt3W2IFVUcx/HvXRW1VdQedy1bZVfoYX0osVQyfSGElKbRA5oFIaIlhAkWUYm6gvqqDMHMoBeKlhayCCZC2AMRPay7aJrSZmauZhQqaj7t7u1Fi965987s7D1n7pk7/j73zX2Y85//mXt2Zu45Z2ZBREREREREREREREREREREREREREREREREREREREREREREREREROIiZSFGH+YxgsOs5U/X1bFiPDPpQT3bu1DmcaZyg+vErWpjD+s47zoN6Mte0qRJc4Iq18lYMJv2jvosD11mRUeJpD32UO7664BFGQl94DoZY704fbU2rQwKVWYwbc6bQlSPBaYbtMz4K7nP53lpGkK/q8+7MTxUmeEWtmJcGX+j5psmM0I3l9vCirKAV36OuE46QsbfaHL/9opnL9tcpxBf3V0nkAgzWMRj9HadhrH+3Gk7pBqYDZdY3oXfnHE2gc1U2gyoQ6Rk+pKZdgOqgYnXF7TYDGe3gcWgW85QH9cJxMAVm8HsNrBqhhV1U9g33XUCzo1gsM1wdhtYio8ZWsytYdksFrpOwbGhbLYb0PavyLs5wA+c9v28lRa+Zzt/+y5RwwKqaOCdgCjZRvEit/A1a7jou8xwJjOMAb7D+ylqqCmw1imeZ0oCBrv7Mzp+/QofFTDCdZG13Jw3Wi1nOpbZT9+QGUziUkeZ3T49z+P4pqCRuCkhM1jjfMwwqsdG182rsAaWJs0JxuWJ9knGEq+EzODHjDLTcj5NsbjgwehwDazm6vyL5D2MG5i7booKdjE25917M57XhoxUG1hmJUsjrmWtlVl18ZQ2DeCyH6ycT7kpIJ+wuQWVeZJXI69HcpsXHDQN4LajtZIlkcbvzWqn9St1R3nPNIT93wzt/MSZPO+nqKA65699Nos5FdHmgZkMzHnvIj9zLm9+Q7jd0nqP8VtkdSqWNppYxT+u08g+yW8OnKRXw4ac08hnPUscyvjkw5AZXM4os9jzyY6sdZ3h5YC++jLm0lrASf50T5krzEn0QbOLbB8in2FvwKfNPJczCXd0hLV7wPPqL8bybt691//aWWfhkPo2681PjZPDbgP7lYZOl1nNJs9rW4elXD2zfkK8wIFOy2w1XuuWyOpTkuw2sHOhlqrzvIqu59gbuYEdIcqcjSyb65SLX5EHOepgrbuKtJ6nHNQtxtx0U5xM8DoXMkez7K5xM7Tp4iS4WOvszvss5feSP9Fvo5EVnDDfHGJfpd157Y48xFRGmfaEaWcu/qqYZxpCDcxcqR8Mg9xlGkANzNz+BDcx4zEJNTBzv5gPCSeXTvJtmM+3PJqIKdNj6GE3pJsG5mIwOMp1ptnABgd1sq+G7ebnXZncHCKjG3+M1zpLTzMz7AZ00cBG5pmlFb3JmkQTSpPd21HZbWD9Qy21zPPK/zricNH6+B7mvZFreTpEtAFWt0dpsnoWZreBVTG+kyVS1GVN4/vDd9lJVIRY5yzfPdPlrPHHdTwYItr1bkLcTia8M1qPM9F3yRRjcuaYprNmHxzyfNbQyQlnGTM47ynhndFan7WuCywLODz35I2sC9DCXheZHBNpsXvZmu1fkZXs5rjPnPzb8hyAzrIzINr9HOBIwNXat+ZcleS1hame1714izc55jNvbVDBtz7pyWuJuI15P/tnx1F0UwzsQpprO5nil2KIQSZbqcspnwp57+iu2MQT1mMmhNue/MMR3xfwMi8VYRhnmJqXP/MG1lZwyVNMy9l/FR4tf/mdvB553Uz2sXFn+n1YaGCNBZZr5mH25by7xzCb3PKrmM+lgmK1BV4hdc0+2g2zjq8m1wlAOY1dvqXGKep87oZYzUmDW3Vs8+myuIf6Am6AsiT0Nljp/CYl0Twaze9ZaaN3u5w5jAy5L2ylhe/4nAu+S1Qwl+oCsrjCV2wM2KXfwSPUcmPIGv9LPZ91Ye1TEnEb80ztNLE+Dv8MS0RERERERERERERERERERERERERERERERERERERERERERERERERs+Q/rhi5WauEgfQAAAABJRU5ErkJggg==
  description: 'These endpoints handle the retrieval of actionable insights for a customer. An actionable insight is an indicator of

    the state of a customer''s financial situation that could induce a change in behaviour.'
servers:
- url: https://api-sandbox.thisisbud.com
  description: Bud sandbox
tags:
- name: Customer-Level Insights
  x-displayName: Customer-Level Insights
  description: Retrieve flags and facts calculated in real time from a customer's financial data.
paths:
  /insights/v1/customer-level/facts:
    get:
      tags:
      - Customer-Level Insights
      summary: List Customer-Level Facts
      description: Calculate every fact available to you from the customer's data.
      operationId: v1_organisation_customer_facts_list
      security:
      - OAuth2: []
      parameters:
      - $ref: '#/paths/~1widget~1v1~1summary~1url/post/parameters/0'
      - $ref: '#/paths/~1widget~1v1~1summary~1url/post/parameters/1'
      - $ref: '#/paths/~1widget~1v1~1summary~1url/post/parameters/2'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: List Customer-Level Facts Response
                type: object
                required:
                - operation_id
                - data
                properties:
                  operation_id:
                    type: string
                    enum:
                    - v1_organisation_customer_facts_list
                  data:
                    type: array
                    items:
                      $ref: '#/paths/~1insights~1v1~1customer-level~1facts~1{fact_name}/get/responses/200/content/application~1json/schema/properties/data'
              example:
                operation_id: v1_organisation_customer_facts_list
                data:
                - name: total_income
                  description: Total income received by the customer in the specified time period.
                  value: 12750
                - name: mean_income
                  description: Income of the customer in the specified time period, averaged by table time interval.
                  value: 4250
                - name: has_mortgage
                  description: Indicates whether the customer has at least 1 mortgage transaction in the specified time period. Does not say who the mortgage is with.
                  value: true
        '400':
          $ref: '#/components/responses/InvalidParameters'
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '404':
          description: The customer was not found.
          content:
            application/json:
              schema:
                $ref: '#/paths/~1insights~1v1~1customer-level~1flags/get/responses/404/content/application~1json/schema'
        5XX:
          $ref: '#/components/responses/ServerError'
  /insights/v1/customer-level/facts/{fact_name}:
    get:
      tags:
      - Customer-Level Insights
      summary: Retrieve Customer-Level Fact
      description: Calculate a single fact from the customer's data.
      operationId: v1_organisation_customer_fact_get
      security:
      - OAuth2: []
      parameters:
      - $ref: '#/paths/~1widget~1v1~1summary~1url/post/parameters/0'
      - $ref: '#/paths/~1widget~1v1~1summary~1url/post/parameters/1'
      - $ref: '#/paths/~1widget~1v1~1summary~1url/post/parameters/2'
      - in: path
        name: fact_name
        required: true
        description: The name of the fact, as returned by __List Customer-Level Facts__.
        schema:
          type: string
        example: total_income
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: Retrieve Customer-Level Fact Response
                type: object
                required:
                - operation_id
                - data
                properties:
                  operation_id:
                    type: string
                    enum:
                    - v1_organisation_customer_fact_get
                  data:
                    title: Customer-Level Fact
                    description: A fact calculated from a customer's data.
                    type: object
                    required:
                    - name
                    - description
                    properties:
                      name:
                        type: string
                        description: The unique name of the fact.
                        example: total_income
                      description:
                        type: string
                        description: A description of what the fact measures.
                      value:
                        description: The fact's value for the customer. Omitted when the fact has no value for the customer, for example a date for an event that has not happened.
                        oneOf:
                        - type: number
                        - type: string
                        - type: boolean
              example:
                operation_id: v1_organisation_customer_fact_get
                data:
                  name: total_income
                  description: Total income received by the customer in the specified time period.
                  value: 12750
        '400':
          $ref: '#/components/responses/InvalidParameters'
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '404':
          description: The customer or the fact was not found.
          content:
            application/json:
              schema:
                $ref: '#/paths/~1insights~1v1~1customer-level~1flags/get/responses/404/content/application~1json/schema'
        5XX:
          $ref: '#/components/responses/ServerError'
  /insights/v1/customer-level/flags:
    get:
      tags:
      - Customer-Level Insights
      summary: List Customer-Level Flags
      description: 'Evaluate every flag available to you against the customer''s data, and return each flag with whether the

        customer matched it.'
      operationId: v1_organisation_customer_flags_list
      security:
      - OAuth2: []
      parameters:
      - $ref: '#/paths/~1widget~1v1~1summary~1url/post/parameters/0'
      - $ref: '#/paths/~1widget~1v1~1summary~1url/post/parameters/1'
      - $ref: '#/paths/~1widget~1v1~1summary~1url/post/parameters/2'
      - in: query
        name: matched
        required: false
        description: When `true`, only flags that matched the customer are returned.
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: List Customer-Level Flags Response
                type: object
                required:
                - operation_id
                - data
                properties:
                  operation_id:
                    type: string
                    enum:
                    - v1_organisation_customer_flags_list
                  data:
                    type: array
                    items:
                      $ref: '#/paths/~1insights~1v1~1customer-level~1flags~1{flag_id}/get/responses/200/content/application~1json/schema/properties/data'
              example:
                operation_id: v1_organisation_customer_flags_list
                data:
                - id: credit_card_user
                  display_name: Credit card user
                  description: Customers that make credit card repayments or have a credit card account
                  matched: true
                - id: ad_hoc_saver
                  display_name: Ad-hoc saver
                  description: Customers who save irregularly, with savings amounts that vary significantly month to month
                  matched: false
        '400':
          $ref: '#/components/responses/InvalidParameters'
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '404':
          description: The customer was not found.
          content:
            application/json:
              schema:
                title: Bad Request Not Found Response
                type: object
                required:
                - operation_id
                - code_id
                - message
                properties:
                  operation_id:
                    title: Operation Id Field
                    type: string
                    description: A unique identifier/reference associated with a given endpoint/operation
                  code_id:
                    type: string
                    description: A descriptive enough string that is linked to the reason for the error.
                  message:
                    type: string
                    description: An actual user friendly error message.
        5XX:
          $ref: '#/components/responses/ServerError'
  /insights/v1/customer-level/flags/{flag_id}:
    get:
      tags:
      - Customer-Level Insights
      summary: Retrieve Customer-Level Flag
      description: Evaluate a single flag against the customer's data, and return whether the customer matched it.
      operationId: v1_organisation_customer_flag_get
      security:
      - OAuth2: []
      parameters:
      - $ref: '#/paths/~1widget~1v1~1summary~1url/post/parameters/0'
      - $ref: '#/paths/~1widget~1v1~1summary~1url/post/parameters/1'
      - $ref: '#/paths/~1widget~1v1~1summary~1url/post/parameters/2'
      - in: path
        name: flag_id
        required: true
        description: The ID of the flag, as returned by __List Customer-Level Flags__.
        schema:
          type: string
        example: credit_card_user
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                title: Retrieve Customer-Level Flag Response
                type: object
                required:
                - operation_id
                - data
                properties:
                  operation_id:
                    type: string
                    enum:
                    - v1_organisation_customer_flag_get
                  data:
                    title: Customer-Level Flag
                    description: A flag evaluated against a customer's data.
                    type: object
                    required:
                    - id
                    - display_name
                    - description
                    - matched
                    properties:
                      id:
                        type: string
                        description: The unique ID of the flag.
                        example: credit_card_user
                      display_name:
                        type: string
                        description: A human-readable name for the flag.
                        example: Credit card user
                      description:
                        type: string
                        description: A description of what the flag identifies.
                      matched:
                        type: boolean
                        description: Whether the customer meets the flag's criteria.
              example:
                operation_id: v1_organisation_customer_flag_get
                data:
                  id: credit_card_user
                  display_name: Credit card user
                  description: Customers that make credit card repayments or have a credit card account
                  matched: true
        '400':
          $ref: '#/components/responses/InvalidParameters'
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '404':
          description: The customer or the flag was not found.
          content:
            application/json:
              schema:
                $ref: '#/paths/~1insights~1v1~1customer-level~1flags/get/responses/404/content/application~1json/schema'
        5XX:
          $ref: '#/components/responses/ServerError'
components:
  responses:
    InvalidParameters:
      description: The request contains invalid parameters.
      content:
        application/json:
          schema:
            title: Bad Request Response
            type: object
            description: Expected response structure
            required:
            - operation_id
            - code_id
            - message
            - errors
            properties:
              operation_id:
                $ref: '#/paths/~1insights~1v1~1customer-level~1flags/get/responses/404/content/application~1json/schema/properties/operation_id'
              code_id:
                type: string
                description: A descriptive enough string that is linked to the reason for the error.
              message:
                type: string
              errors:
                anyOf:
                - title: Error Object
                  type:
                  - object
                  - 'null'
                  description: Contains a field specific error message
                  additionalProperties:
                    type: string
                - title: Array of Error Object
                  description: Contains a list of error messages
                  type: object
                  additionalProperties:
                    type: array
                    items:
                      type: string
    Unauthenticated:
      description: The request was not authenticated, or the client does not have access to this endpoint.
    ServerError:
      description: An unexpected error occurred on the server side.
      content:
        application/json:
          schema:
            title: Server Error Response
            type: object
            required:
            - operation_id
            - code_id
            - message
            properties:
              operation_id:
                $ref: '#/paths/~1insights~1v1~1customer-level~1flags/get/responses/404/content/application~1json/schema/properties/operation_id'
              code_id:
                type: string
                description: A descriptive enough string that is linked to the reason for the error.
              message:
                type: string
                description: An actual user friendly error message.
              errors:
                anyOf:
                - $ref: '#/components/responses/InvalidParameters/content/application~1json/schema/properties/errors/anyOf/0'
                - $ref: '#/components/responses/InvalidParameters/content/application~1json/schema/properties/errors/anyOf/1'
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: /v1/oauth/token
          scopes: {}
      description: "\nAuthentication flow:\n\n1. Perform OAuth2 Client Credentials authentication using API Credentials (`client_id`,`client_secret`) to obtain an `access_token` against `/v1/oauth/token` endpoint,\n2. Use `access_token` as Bearer Authorisation for every other API request,\n3. Include `X-Client-Id` (=client_id) within the header of every API request,\n4. Note that some of the requests may also require `X-Customer-Id` to be provided within the request header.\n\n### Examples\nObtain OAuth2 `access_token` and `refresh_token` using `grant_type=client_credentials` and HTTP Basic auth header\n\n```\ncurl --basic --user {{client_id}}:{{client_secret}} \\\n  -X POST https://api-sandbox.thisisbud.com/v1/oauth/token \\\n  -H 'Content-Type: application/x-www-form-urlencoded' \\\n  -d grant_type=client_credentials\n```\n\nSuccessful response:\n```\n{\n  \"operation_id\": \"oauth_token_post\",\n  \"data\": {\n    \"access_token\": \"dd0c17e3fd6d2ce94aa091257a3ea393b4f9b5cf3d3e998f07dc9826da86ff15\",\n    \"token_type\": \"bearer\",\n    \"expires_in\": 3600,\n    \"refresh_token\": \"fac32cca7559d9f6e8f1dfe9a99c71fa1dcfeb482bedf287d7934d2667ae54b3\"\n  }\n}\n```\n\nRefresh `access_token` token using `refresh_token` against `/v1/oauth/token` endpoint with `grant_type=refresh_token`\n\n```\ncurl -X POST \\\n  https://api-sandbox.thisisbud.com/v1/oauth/token \\\n  -H 'Content-Type: application/x-www-form-urlencoded' \\\n  -H 'X-Client-Id: {{client_id}}' \\\n  -d 'grant_type=refresh_token&refresh_token={{refresh_token}}'\n```\n\nSuccessful response:\n```\n{\n    \"operation_id\": \"oauth_token_post\",\n    \"data\": {\n        \"access_token\": \"cc0c17e3fd6d2ce94aa091257a3ea393b4f9b5cf3d3e998f07dc9826da86ff94\",\n        \"token_type\": \"bearer\",\n        \"expires_in\": 3600,\n        \"refresh_token\": \"ffc30cca7559d9f6e8f1dfe9a99c71fa1dcfeb482bedf287d7934d2667ae54b3\"\n    }\n}\n```\n"
x-provenance:
  method: searched
  source: https://docs-us.thisisbud.com/reference
  harvested: '2026-10-21'
  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-us.thisisbud.com/reference/custom_insight_v1_detail_get.md
  - https://docs-us.thisisbud.com/reference/custom_insight_v1_manage_delete.md
  - https://docs-us.thisisbud.com/reference/custom_insight_v1_manage_delete_all.md
  - https://docs-us.thisisbud.com/reference/custom_insight_v1_manage_get.md
  - https://docs-us.thisisbud.com/reference/custom_insight_v1_manage_patch.md
  - https://docs-us.thisisbud.com/reference/custom_insight_v1_manage_post.md
  - https://docs-us.thisisbud.com/reference/custom_insight_v1_profile_get.md
  - https://docs-us.thisisbud.com/reference/custom_insight_v1_profile_post.md
  - https://docs-us.thisisbud.com/reference/insights_v1_accounts_url_post.md
  - https://docs-us.thisisbud.com/reference/insights_v1_action_cards_url_post.md
  - https://docs-us.thisisbud.com/reference/insights_v1_actionable_balances_details_get.md
  - https://docs-us.thisisbud.com/reference/insights_v1_actionable_balances_get.md
  - https://docs-us.thisisbud.com/reference/insights_v1_actionable_income_details_get.md
  - https://docs-us.thisisbud.com/reference/insights_v1_actionable_income_get.md
  - https://docs-us.thisisbud.com/reference/insights_v1_actionable_spending_details_get.md
  - https://docs-us.thisisbud.com/reference/insights_v1_actionable_spending_get.md
  - https://docs-us.thisisbud.com/reference/insights_v1_balances_over_time_url_post.md
  - https://docs-us.thisisbud.com/reference/insights_v1_financial_calendar_url_post.md
  - https://docs-us.thisisbud.com/reference/insights_v1_intelligent_search_url_post-1.md
  - https://docs-us.thisisbud.com/reference/insights_v1_net_worth_url_post.md
  - https://docs-us.thisisbud.com/reference/insights_v1_recurring_and_forecasted_transactions_url_post.md
  - https://docs-us.thisisbud.com/reference/insights_v1_savings_goals_url_post.md
  - https://docs-us.thisisbud.com/reference/insights_v1_spending_analysis_url_post.md
  - https://docs-us.thisisbud.com/reference/insights_v1_spending_budgets_url_post.md
  - https://docs-us.thisisbud.com/reference/insights_v1_summary_url_post.md
  - https://docs-us.thisisbud.com/reference/v1_organisation_customer_fact_get.md
  - https://docs-us.thisisbud.com/reference/v1_organisation_customer_facts_list.md
  - https://docs-us.thisisbud.com/reference/v1_organisation_customer_flag_get.md
  - https://docs-us.thisisbud.com/reference/v1_organisation_customer_flags_list.md
  - https://docs.thisisbud.com/reference/custom_insight_v1_detail_get.md
  - https://docs.thisisbud.com/reference/custom_insight_v1_manage_delete.md
  - https://docs.thisisbud.com/reference/custom_insight_v1_manage_delete_all.md
  - https://docs.thisisbud.com/reference/custom_insight_v1_manage_get.md
  - https://docs.thisisbud.com/reference/custom_insight_v1_manage_patch.md
  - https://docs.thisisbud.com/reference/custom_insight_v1_manage_post.md
  - https://docs.thisisbud.com/reference/custom_insight_v1_profile_get.md
  - https://docs.thisisbud.com/reference/custom_insight_v1_profile_post.md
  - https://docs.thisisbud.com/reference/insights_v1_accounts_url_post.md
  - https://docs.thisisbud.com/reference/insights_v1_action_cards_url_post.md
  - https://docs.thisisbud.com/reference/insights_v1_actionable_balances_details_get.md
  - https://docs.thisisbud.com/reference/insights_v1_actionable_balances_get.md
  - https://docs.thisisbud.com/reference/insights_v1_actionable_income_details_get.md
  - https://docs.thisisbud.com/reference/insights_v1_actionable_income_get.md
  - https://docs.thisisbud.com/reference/insights_v1_actionable_spending_details_get.md
  - https://docs.thisisbud.com/reference/insights_v1_actionable_spending_get.md
  - https://docs.thisisbud.com/reference/insights_v1_balances_over_time_url_post.md
  - https://docs.thisisbud.com/reference/insights_v1_financial_calendar_url_post.md
  - https://docs.thisisbud.com/reference/insights_v1_intelligent_search_url_post-1.md
  - https://docs.thisisbud.com/reference/insights_v1_net_worth_url_post.md
  - https://docs.thisisbud.com/reference/insights_v1_recurring_and_forecasted_transactions_url_post.md
  - https://docs.thisisbud.com/reference/insights_v1_savings_goals_url_post.md
  - https://docs.thisisbud.com/reference/insights_v1_spending_analysis_url_post.md
  - https://docs.thisisbud.com/reference/insights_v1_spending_budgets_url_post.md
  - https://docs.thisisbud.com/reference/insights_v1_summary_url_post.md
  - https://docs.thisisbud.com/reference/v1_organisation_customer_fact_get.md
  - https://docs.thisisbud.com/reference/v1_organisation_customer_facts_list.md
  - https://docs.thisisbud.com/reference/v1_organisation_customer_flag_get.md
  - https://docs.thisisbud.com/reference/v1_organisation_customer_flags_list.md
  merge:
    pages: 58
    deduped: 175
    conflicts_kept_first: 68