Get Poll

Get poll details

Path Parameters

companyID companyID required

The id of the company

pollID pollID required

The id of the poll

Responses

• 200
• 404

---

A poll object

application/json

Schema

Example (from schema)

---

Schema

id string

Unique ID of the poll

createdAt date-time

Date the poll was created

updatedAt date-time

Date the poll was last updated

title string

Title of the poll

schedule string

Schedule of the poll

startDate date-time

Start date of the poll

endDate date-time

End date of the poll

timeZone string nullable

Time zone of the poll

audience object
Audience target of the poll
filters object[]
List of filters to target the audience
Array [
key string
Key of the filter
value string
Value of the filter
]
link string

Link to the poll

sendDates date[]

List of dates the poll was sent

{
  "id": "2020-01-01:2e8f9915-fda0-450c-95a3-d61f93c66fa9",
  "createdAt": "2021-01-01T00:00:00.000Z",
  "updatedAt": "2021-01-01T00:00:00.000Z",
  "title": "",
  "schedule": "rate(1 day)",
  "startDate": "2021-01-01T00:00:00.000Z",
  "endDate": "2021-01-01T00:00:00.000Z",
  "timeZone": "America/New_York",
  "audience": {
    "filters": [
      {
        "key": "team",
        "value": "2e8f9915-fda0-450c-95a3-d61f93c66fa9"
      }
    ]
  },
  "link": "https://app.at.cafe/polls/2e8f9915-fda0-450c-95a3-d61f93c66fa9",
  "sendDates": [
    "2021-01-01"
  ]
}

An error when the poll is not found

application/json

Schema

Example (from schema)

---

Schema

message string

Error message

{
  "message": "User not found"
}

Loading...