GET/projects/api/v3/forms.json

Get all forms.

Return a list of all forms.

Query Params

  • Name
    token.state
    Type
    string
    Description

    query by token state

    Allowed values
    • active
    • inactive
  • Name
    searchTerm
    Type
    string
    Description

    filter by form name

  • Name
    orderMode
    Type
    string
    Description

    order mode

    Default
    asc
    Allowed values
    • asc
    • desc
  • Name
    orderBy
    Type
    string
    Description

    order by

    Default
    dateUpdated
    Allowed values
    • name
    • taskList
    • totalSubmissions
    • dateCreated
    • dateUpdated
  • Name
    hostObject.type
    Type
    string
    Description

    query by hostObject type

    Allowed values
    • projects
  • Name
    content.state
    Type
    string
    Description

    query by form state

    Allowed values
    • active
    • deleted
    • draft
    • latest
  • Name
    userId
    Type
    integer
    Description

    filter by user id

  • Name
    pageSize
    Type
    integer
    Description

    number of items in a page

    Default
    50
  • Name
    page
    Type
    integer
    Description

    page number

    Default
    1
  • Name
    hostObject.id
    Type
    integer
    Description

    filter by host id

  • Name
    skipCounts
    Type
    boolean
    Description

    SkipCounts allows you to skip doing counts on a list API endpoint for performance reasons.

  • Name
    onlyProjectsWithExplicitMembership
    Type
    boolean
    Description

    filter only by project with direct membership

  • Name
    includeArchivedProjects
    Type
    boolean
    Description

    include archived projects

  • Name
    projectIds
    Type
    array[integer]
    Description

    filter by project ids

    Format
    Comma separated values
  • Name
    include
    Type
    array[string]
    Description

    include

    Format
    Comma separated values
    Allowed values
    • projects
    • projects.companies
    • users
    • tasklists
  • Name
    fields[users]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • firstName
    • lastName
    • title
    • email
    • companyId
    • company
    • isAdmin
    • isClientUser
    • isServiceAccount
    • type
    • deleted
    • avatarUrl
    • lengthOfDay
    • workingHoursId
    • workingHour
    • userRate
    • userCost
    • canAddProjects
  • Name
    fields[tasklists]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • projectId
    • milestoneId
  • Name
    fields[projects]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
  • Name
    fields[forms]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • confirmationMessage
    • promptAdditionalSubmissions
    • allowTeamworkBranding
    • isShared
    • state
    • taskTitleFieldId
    • token
    • content
    • hostObject
    • installation
  • Name
    fields[companies]
    Type
    array[string]
    Description
    Format
    Comma separated values
    Allowed values
    • id
    • name
    • logoUploadedToServer
    • logoImage

Responses

  • Code
    200
    Type
    object
    Schema
    Description
    200 OK
    FormsResponse contains information about a group of forms.
  • Code
    400
    Type
    object
    Schema
    Description
    400 Bad Request
    ErrorResponse defines how []Error should be marshaled to JSON.

Examples

200 OK

FormsResponse
{  "forms": [    {      "allowTeamworkBranding": true,      "backgroundColor": "string",      "confirmationMessage": "string",      "content": {        "banner": {          "primaryColor": "string",          "url": "string",          "x": 0,          "y": 0        },        "definition": "string",        "description": "string",        "logo": {          "url": "string"        },
Download Swagger