List All Openings

List Openings (Funnels)

List all Openings within your account. Funnel is used interchangeably with Opening.

Each Opening contains information on address, stages for the funnel, location, active status, and other.Check the example to see what properties are available.

Use the page parameter to indicate the page for pagination, e.g. ?page=2 to get to the 2nd page of the listing.

additionalProperties: false
funnels
- Required: yes
- Type: array
- Items
  - Required: no
  - additionalProperties: false
  - id
    Required: yes
    Type: string
    Example: "49dbf2f3-057f-44b4-a638-8fac5aac2adf"
  - custom_id
    Required: yes
    Type: string
    Example: "3d67750a-dcf4-4ada-a3e4-ee44661949fc"
  - title
    Required: yes
    Type: string
    Example: "My Public Funnel"
  - address
    Required: yes
    Type: string
    Example: "5th Ave. 13"
  - time_zone
    Required: yes
    Type: string
    Example: "UTC"
  - description
    Required: no
    Type: string
    Example: "This funnel is for anyone"
  - requirements
    Required: yes
    Type: string
    Example: "No need"
  - fields
    Required: yes
    Type: array
    Items
    Required: no
    additionalProperties: false
    question
    Required: no
    Type: string
    Example: "Foo"
    type
    Required: no
    Type: string
    Example: "text_field"
    key
    Required: no
    Type: string
    Example: "foo"
  - stages
    Required: yes
    Type: array
    Items
    Required: no
    additionalProperties: false
    id
    Required: yes
    Type: string
    Example: "70d446ca-670d-44be-a728-6c3d1921fb97"
    title
    Required: yes
    Type: string
    Example: "Approved"
    type
    Required: yes
    Type: string
    Example: "HiredStage"
  - is_private
    Required: yes
    Type: boolean
    Example: false
  - active
    Required: yes
    Type: boolean
    Example: true
  - location
    Required: no
    additionalProperties: false
    id
    Required: yes
    Type: string
    Example: "7f88228c-cba9-4827-b71d-e81244c05d37"
    name
    Required: yes
    Type: string
    Example: "San Francisco"
pagination
- Required: yes
- additionalProperties: false
- first
  - Required: yes
  - Type: integer
  - Example: 1
- previous
  - Required: yes
  - Type: null
  - Example: ""
- current
  - Required: yes
  - Type: integer
  - Example: 1
- next
  - Required: yes
  - Type: null
  - Example: ""
- last
  - Required: yes
  - Type: integer
  - Example: 1