> ## Documentation Index > Fetch the complete documentation index at: https://docs.moonbase.ai/llms.txt > Use this file to discover all available pages before exploring further. # List Funnels > Returns a list of funnels. ## OpenAPI ````yaml GET /funnels openapi: 3.1.0 info: title: Moonbase REST API version: v0 servers: - url: https://api.moonbase.ai/v0 security: - bearer: [] tags: - name: Inboxes description: Manage your inboxes, conversations, and messages - name: Collections description: Manage your collections and items - name: Marketing description: Manage your marketing campaigns and forms - name: Activities description: View activities and capture calls - name: Library description: Manage your meetings, files, and notes paths: /funnels: get: tags: - Collections summary: List funnels description: Returns a list of funnels. parameters: - name: before in: query required: false schema: type: string description: >- When specified, returns results starting immediately before the item identified by this cursor. Use the cursor value from the response's metadata to fetch the previous page of results. explode: true - name: after in: query required: false schema: type: string description: >- When specified, returns results starting immediately after the item identified by this cursor. Use the cursor value from the previous response's metadata to fetch the next page of results. explode: true - name: limit in: query required: false schema: type: integer minimum: 1 maximum: 100 default: 20 description: >- Maximum number of items to return per page. Must be between 1 and 100. Defaults to 20 if not specified. explode: true responses: '200': description: Successful response. content: application/json: schema: type: object description: A set of results using cursor-based pagination. properties: type: type: string const: list data: type: array description: An array of Funnel items. items: $ref: '#/components/schemas/Funnel' meta: type: object description: >- Metadata about the pagination, including the cursors pointing to the previous and next pages. properties: cursors: type: object properties: prev: type: string description: >- Cursor for the previous page. This value should be used with the `before` query parameter to fetch the previous page of results. next: type: string description: >- Cursor for the next page. This value should be used with the `after` query parameter to fetch the next page of results. required: - cursors required: - type - data - meta examples: List funnels: summary: List funnels value: type: list data: - id: 1CLJt2v74fpqiNNRA14BC8 type: funnel name: Onboarding steps: - id: 1CLJt2v7K42Td5rmrJ8mJu type: funnel_step step_type: active name: Step 1 color: red - id: 1CLJt2v7ZSE5XoM8YbDMRg type: funnel_step step_type: active name: Step 2 color: red - id: 1CLJt2v7opRhSWqVEtHwYT type: funnel_step step_type: active name: Step 3 color: red - id: 1CLJt2v84CdKMEKqwBNXfE type: funnel_step step_type: success name: Step 4 color: red - id: 1CLJt2v8JapwFwpCdUT7n1 type: funnel_step step_type: failure name: Step 5 color: red created_at: '2025-02-17T16:00:00.000Z' updated_at: '2025-02-17T16:00:00.000Z' - id: 1CLJt2v5aNd8G5SGzEaeVU type: funnel name: Sales Pipeline steps: - id: 1CLJt2v5pkpkAnvdgXfEcF type: funnel_step step_type: active name: Step 1 color: red - id: 1CLJt2v6592N5WQzNpjpj2 type: funnel_step step_type: active name: Step 2 color: red - id: 1CLJt2v6KXDyzDuM57pQqo type: funnel_step step_type: active name: Step 3 color: red - id: 1CLJt2v6ZuRbtwPhmQtzxa type: funnel_step step_type: success name: Step 4 color: red - id: 1CLJt2v6pHdDoet4Thyb5M type: funnel_step step_type: failure name: Step 5 color: red created_at: '2025-02-17T16:00:00.000Z' updated_at: '2025-02-17T16:00:00.000Z' - id: 1CLJt2uZa4PDHXH6vc1UMb type: funnel name: Deals steps: - id: 1CLJt2uZpSaqCEmTcu64UN type: funnel_step step_type: active name: Lead color: blue - id: 1CLJt2ua4pnT6xFpKCAeb9 type: funnel_step step_type: active name: Qualification color: cyan - id: 1CLJt2uaKCz51fkB1VFEhv type: funnel_step step_type: active name: Demo color: orange - id: 1CLJt2uaZbBgvPEXhnKpph type: funnel_step step_type: active name: Proposal color: yellow - id: 1CLJt2uaoyPJq6itQ5QQwU type: funnel_step step_type: active name: Negotiation color: pink - id: 1CLJt2ub4MavjpDF6NV14F type: funnel_step step_type: success name: Closed Won color: emerald - id: 1CLJt2ubJjnYeXhbnfZbB2 type: funnel_step step_type: failure name: Closed Lost color: rose created_at: '2025-02-17T16:00:00.000Z' updated_at: '2025-02-17T16:00:00.000Z' meta: cursors: {} '400': description: '' content: application/json: schema: $ref: '#/components/schemas/Errors' examples: Default: summary: Default value: type: errors errors: - type: error status: '400' title: Bad Request detail: >- The request could not be understood due to malformed syntax or invalid parameters. '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Errors' examples: Default: summary: Default value: type: errors errors: - type: error status: '401' title: Unauthorized detail: >- Invalid or missing API key or JWT. You should provide your Moonbase API Key or JWT in the authorization header, in the format: "Authorization: Bearer MOONBASE_API_KEY" '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Errors' examples: Default: summary: Default value: type: errors errors: - type: error status: '403' title: Forbidden '429': description: Too Many Requests content: application/json: schema: $ref: '#/components/schemas/Errors' examples: Default: summary: Default value: type: errors errors: - type: error status: '429' title: Too Many Requests '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Errors' examples: Default: summary: Default value: type: errors errors: - type: error status: '500' title: Internal Server Error '503': description: Service Unavailable content: application/json: schema: $ref: '#/components/schemas/Errors' examples: Default: summary: Default value: type: errors errors: - type: error status: '503' title: Service Unavailable detail: >- The service is temporarily unavailable, please try again later. x-codeSamples: - lang: JavaScript source: |- import Moonbase from '@moonbaseai/sdk'; const client = new Moonbase({ apiKey: process.env['MOONBASE_API_KEY'], // This is the default and can be omitted }); // Automatically fetches more pages as needed. for await (const funnel of client.funnels.list()) { console.log(funnel.id); } - lang: Python source: |- import os from moonbase import Moonbase client = Moonbase( api_key=os.environ.get("MOONBASE_API_KEY"), # This is the default and can be omitted ) page = client.funnels.list() page = page.data[0] print(page.id) - lang: Go source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/moonbaseai/moonbase-sdk-go\"\n\t\"github.com/moonbaseai/moonbase-sdk-go/option\"\n)\n\nfunc main() {\n\tclient := moonbase.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tpage, err := client.Funnels.List(context.TODO(), moonbase.FunnelListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n" - lang: Ruby source: |- require "moonbase" moonbase = Moonbase::Client.new(api_key: "My API Key") page = moonbase.funnels.list puts(page) components: schemas: Funnel: title: Funnel description: A Funnel represents a series of steps used to track progression. type: object properties: type: description: >- String representing the object’s type. Always `funnel` for this object. type: string const: funnel id: description: Unique identifier for the object. type: string name: description: The name of the funnel. type: string steps: description: An ordered list of `FunnelStep` objects that make up the funnel. type: array items: $ref: '#/components/schemas/FunnelStep' created_at: description: >- Time at which the object was created, as an ISO 8601 timestamp in UTC. type: string format: date-time updated_at: description: >- Time at which the object was last updated, as an ISO 8601 timestamp in UTC. type: string format: date-time required: - name - type - id - steps - created_at - updated_at Errors: title: Errors description: >- The Errors object is a container that holds multiple Error objects when an API request encounters several validation or processing issues. This allows the API to return comprehensive feedback about all problems encountered in a single response. type: object properties: type: type: string const: errors errors: description: A list of `Error` objects. type: array items: $ref: '#/components/schemas/Error' required: - type FunnelStep: title: FunnelStep description: Represents a single step within a `Funnel`. type: object properties: type: description: >- String representing the object’s type. Always `funnel_step` for this object. type: string const: funnel_step id: description: Unique identifier for the object. type: string step_type: description: | The status of the step in the funnel flow. - `active`: represents an in progress state within the funnel - `success`: completed successfully and exited the funnel - `failure`: exited the funnel without conversion type: string enum: - active - success - failure name: description: The name of the step. type: string color: $ref: '#/components/schemas/NamedColor' description: The display color of the step. required: - name - type - id - step_type - color Error: title: Error description: >- The Error object represents a single error that occurred during API request processing. It provides detailed information about what went wrong, including a unique identifier, status code, and human-readable descriptions to help developers understand and resolve the issue. type: object properties: type: type: string const: error id: description: A unique identifier for this specific error instance. type: string status: description: The HTTP status code for this problem, as a string. type: string code: description: An application-specific error code string. type: string title: description: A short, human-readable summary of the problem. type: string detail: description: A human-readable explanation of this specific error. type: string source: $ref: '#/components/schemas/ErrorSource' description: >- An object containing more specific information about the part of the request that caused the error. meta: type: object additionalProperties: true required: - type NamedColor: type: string enum: - amber - blue - cyan - emerald - fuchsia - green - indigo - lime - lunar - orange - pink - purple - red - rose - sky - teal - violet - yellow description: >- One of Moonbase's standard color names. Moonbase renders these consistently across light and dark modes. ErrorSource: title: ErrorSource description: >- The ErrorSource object provides additional context about the specific part of an API request that caused an error. It can point to either a field in the request document or a query parameter that contains invalid data. type: object properties: pointer: description: >- A JSON Pointer [RFC6901] to the associated entity in the request document. type: string parameter: description: A string indicating which URI query parameter caused the error. type: string required: [] securitySchemes: bearer: type: http scheme: bearer description: Your Moonbase API key. ````