Skip to main content

SharingTagListResponse

Response for list of sharing tags

items object[]required

List of sharing tags

  • Array [
  • createdAtstring<date-time>required

    Creation timestamp

    Example: 2024-01-01T00:00:00Z
    descriptionstring | nullnullable

    Optional description

    Example: Content appropriate for children
    idstring<uuid>required

    Unique sharing tag identifier

    Example: 550e8400-e29b-41d4-a716-446655440000
    namestringrequired

    Display name of the sharing tag

    Example: Kids Content
    seriesCountinteger<int64>required

    Number of series tagged with this sharing tag

    Possible values: >= 0

    Example: 42
    updatedAtstring<date-time>required

    Last update timestamp

    Example: 2024-01-15T10:30:00Z
    userCountinteger<int64>required

    Number of users with grants for this sharing tag

    Possible values: >= 0

    Example: 5
  • ]
  • totalintegerrequired

    Total count

    Possible values: >= 0

    Example: 10
    SharingTagListResponse
    {
    "items": [
    {
    "createdAt": "2024-01-01T00:00:00Z",
    "description": "Content appropriate for children",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Kids Content",
    "seriesCount": 42,
    "updatedAt": "2024-01-15T10:30:00Z",
    "userCount": 5
    }
    ],
    "total": 10
    }