Weeek Public API
  1. Funnels
Weeek Public API
  • Get started
  • Workspace
    • Tag
      • Tag list
      • Create tag
      • Tag
      • Update tag
      • Delete tag
    • Get workspace info
      GET
    • Get workspace members
      GET
  • Task Manager
    • Portfolio
      • Get portfolios
      • Create portfolio
      • Get portfolio
      • Update portfolio
      • Delete portfolio
    • Project
      • Custom Fields
        • Options
          • Create a custom field option
          • Update a custom field option
          • Move a custom field option
          • Delete a custom field option
        • Create a custom field
        • Update a custom field
        • Transfer custom field to task manager
        • Transfer custom field to project
        • Transfer custom field to board
        • Delete a custom field
      • Get project list
      • Create project
      • Update project info
      • Delete project
      • Get project
      • Archive project
      • Un Archive project
    • Board
      • Custom Fields
        • Options
          • Create a custom field option
          • Update a custom field option
          • Move a custom field option
          • Delete a custom field option
        • Create a custom field
        • Update a custom field
        • Transfer custom field to task manager
        • Transfer custom field to project
        • Transfer custom field to board
        • Delete a custom field
      • Get board list
      • Create board
      • Update board
      • Delete board
      • Move board
    • BoardColumn
      • Get board column list
      • Create board column
      • Update board column
      • Delete board column
      • Move board column
    • Task
      • Attachments
        • Upload attachments
      • Time Entries
        • Create a time entry
        • Update a time entry
        • Delete a time entry
      • Watchers
        • Add watchers to a task
        • Remove watchers from a task
      • Get tasks
      • Create task
      • Get one task info
      • Update a task
      • Delete task
      • Complete task
      • Un complete task
      • Change board
      • Change board column
    • Custom Fields
      • Options
        • Create global custom field option
        • Update global custom field option
        • Move global custom field option
        • Delete global custom field option
      • Get global custom fields
      • Create global custom field
      • Update global custom field
      • Transfer global custom field to project
      • Transfer global custom field to board
      • Delete global custom field
  • CRM
    • Funnels
      • Custom Fields
        • Options
          • Create a custom field option
          • Update a custom field option
          • Move a custom field option
          • Delete a custom field option
        • Create a custom field
        • Update a custom field
        • Move a custom field
        • Delete a custom field
      • Get all funnels
        GET
      • Create a funnel
        POST
      • Get a funnel
        GET
      • Update a funnel
        PUT
      • Delete a funnel
        DELETE
    • Funnel Statuses
      • Get all funnel statuses
      • Create a funnel status
      • Get a funnel status
      • Update a funnel status
      • Delete a funnel status
    • Deals
      • Assignees
        • Attach an assignee
        • Detach an assignee
      • Contacts
        • Attach a contact
        • Detach a contact
      • Organizations
        • Attach an organization
        • Detach an organization
      • Tags
        • Attach a tag
        • Detach a tag
      • Tasks
        • Attach a new task
        • Move a attached to the deal task
        • Detach a task
      • Attachments
        • Upload attachments
      • Get all deals
      • Create a deal
      • Get a deal
      • Update a deal
      • Update a deal fields
      • Move a deal
      • Delete a deal
      • Update the deal funnel
      • Update the deal funnel status
    • Organizations
      • Addresses
        • Create an address
        • Update the address
        • Delete the address
      • Emails
        • Create an email
        • Update the email
        • Delete the email
      • Phones
        • Create a phone
        • Update the phone
        • Delete the phone
      • Contacts
        • Attach a contact
        • Detach the contact
      • Tags
        • Attach a tag
        • Detach the tag
      • Get all organizations
      • Create an organization
      • Get an organization
      • Update an organization
      • Delete an organization
    • Contacts
      • Emails
        • Create an email
        • Update the email
        • Delete the email
      • Phones
        • Create a phone
        • Update the phone
        • Delete the phone
      • Tags
        • Attach a tag
        • Detach the tag
      • Get all contacts
      • Create a contact
      • Get a contact
      • Update a contact
      • Delete a contact
    • Currencies
      • Get all currencies
  • User
    • Get profile
      GET
  • Attachments
    • Get an attachment
      GET
  1. Funnels

Get all funnels

GET
/crm/funnels
CRM.Funnel

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************

Responses

🟢200Success
application/json
Body
success
boolean 
optional
funnels
array[object (Funnel) {13}] 
optional
id
string 
read-onlyoptional
creatorId
string <uuid>
read-onlyoptional
currencyId
integer 
optional
Default:
1
name
string 
optional
logo
string <uri> | null 
read-onlyoptional
dealsCount
integer 
read-onlyoptional
dealsAmount
number <double>
read-onlyoptional
isPrivate
boolean 
optional
Default:
false
isBookmarked
boolean 
read-onlyoptional
Default:
false
createdAt
string <date-time>
read-onlyoptional
updatedAt
string <date-time>
read-onlyoptional
team
array[string <uuid>]
optional
customFields
array[object (CustomField) {5}] 
optional
Example
{
  "success": true,
  "funnels": [
    {
      "id": "string",
      "creatorId": "688ebf54-d343-4104-8711-82c2feac534a",
      "currencyId": 1,
      "name": "string",
      "logo": "http://example.com",
      "dealsCount": 0,
      "dealsAmount": 0,
      "isPrivate": false,
      "isBookmarked": false,
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "team": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ],
      "customFields": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string",
          "type": "text",
          "config": {
            "type": "number",
            "precision": 0,
            "currency": 1
          },
          "options": [
            {
              "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              "name": "string",
              "color": "blue"
            }
          ]
        }
      ]
    }
  ]
}
Modified at 2024-02-15 16:24:49
Previous
Delete a custom field
Next
Create a funnel
Built with