Get poll settings for the specified user

GET/poll-settings/{userId}/

API version

v2

Request method

GET

Operation ID

user-get-poll-status

---

Request

• userIdstring

  required

Responses

Format

application/json

Beschreibung

Schema-Dokumentation

• completedAtstring (date-time)
• dontShowUntilstring (date-time)
• ignoredAtstring (date-time)
• shouldShowboolean

  required
• statusstring (one of: completed, muted, ignored, new)

  required
• userIdstring

  required

Beispiel

{
  "completedAt": "2024-12-18T07:57:26.465Z",
  "dontShowUntil": "2024-12-18T07:57:26.465Z",
  "ignoredAt": "2024-12-18T07:57:26.465Z",
  "shouldShow": true,
  "status": "completed",
  "userId": "string"
}

JSON Schema

{
  "properties": {
    "completedAt": {
      "format": "date-time",
      "type": "string"
    },
    "dontShowUntil": {
      "format": "date-time",
      "type": "string"
    },
    "ignoredAt": {
      "format": "date-time",
      "type": "string"
    },
    "shouldShow": {
      "type": "boolean"
    },
    "status": {
      "enum": [
        "completed",
        "muted",
        "ignored",
        "new"
      ],
      "type": "string"
    },
    "userId": {
      "type": "string"
    }
  },
  "required": [
    "userId",
    "shouldShow",
    "status"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/poll-settings/string

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.user.getPollStatus({
  "userId": "string"
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\User\GetPollStatus\GetPollStatusRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new GetPollStatusRequest(
  userId: "string"
));
$response = $client->user()->getPollStatus($request);

var_dump($response->getBody();