Subscriptions

Get Members

Get a List of Members

Get a list of members. Use optional query parameters to filter or sort the result.

GET https://api.dyntube.com/v1/members

Headers

Name / Type / Description
NameTypeDescription
AuthorizationStringBearer YOUR_API_KEY

Query Parameters

Name / Type / Description
NameTypeDescription
pageIntegerPage number
sizeIntegerPage size
planTypeIntegerType of the plan
keywordsStringFilter by username containing the keyword
sortStringSort order of the results. See details below.

200: OK returns a list of members and a pager.

json
{
    "pager": {
        "page": 1,
        "totalPages": 7,
        "totalResults": 7,
        "sort": "Created:-1"
    },
    "members": [
        {
            "id": "OIFTl6w",
            "key": "rtGP2Vkqg",
            "name": "",
            "username": "[email protected]",
            "password": "",
            "storePlanType": 1,
            "status": 1,
            "created": "2020-08-05T10:24:05.128192+00:00",
            "updated": "2020-01-04T11:21:17.7811342+00:00"
        }
    ]
}

Error Responses

Status Code / Description
Status CodeDescription
400Bad Request - Invalid query parameters
401Unauthorized - Invalid or missing API key

Filtering of results

You can filter the results like this:

The following URL will get 20 members, with username containing the provided 'keywords'.

example
https://api.dyntube.com/v1/members?size=20&keywords=dev&sort=Created:-1

Sorting of results

Use the sort query parameter to order results. The format is field:1 for ascending order or field:-1 for descending order.

yaml
# Here are examples to sort by "Created" date.

#Sort by date created descending:
https://api.dyntube.com/v1/members?sort=Created:-1

#Sort by date created ascending:
https://api.dyntube.com/v1/members?sort=Created:1

Code Samples

C\#

csharp
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text.Json;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        string url = "https://api.dyntube.com/v1/members?sort=Created:-1";

        using (var httpClient = new HttpClient())
        {
            httpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "your_access_token_here");

            var response = await httpClient.GetAsync(url);

            if (response.IsSuccessStatusCode)
            {
                var responseBody = await response.Content.ReadAsStringAsync();

                var json = JsonSerializer.Deserialize<MembersResponse>(responseBody);

                foreach (var member in json.Members)
                {
                    Console.WriteLine($"Member ID: {member.Id}");
                    Console.WriteLine($"Username: {member.Username}");
                    Console.WriteLine($"Status: {member.Status}");
                    Console.WriteLine();
                }
            }
            else
            {
                Console.WriteLine($"Failed to get members. Status code: {response.StatusCode}");
            }
        }
    }
}

public class MembersResponse
{
    public Pager Pager { get; set; }
    public Member[] Members { get; set; }
}

public class Pager
{
    public int Page { get; set; }
    public int TotalPages { get; set; }
    public int TotalResults { get; set; }
    public string Sort { get; set; }
}

public class Member
{
    public string Id { get; set; }
    public string Key { get; set; }
    public string Name { get; set; }
    public string Username { get; set; }
    public string Password { get; set; }
    public int StorePlanType { get; set; }
    public int Status { get; set; }
    public DateTime Created { get; set; }
    public DateTime Updated { get; set; }
}

Node.js

javascript
const axios = require('axios');

const getMembers = async () => {
  try {
    const response = await axios.get('https://api.dyntube.com/v1/members', {
      headers: { Authorization: 'Bearer YOUR_API_KEY' }
    });
    const members = response.data.members;
    console.log(members);
  } catch (error) {
    console.error(error);
  }
};

getMembers();

Python

python
import requests

url = "https://api.dyntube.com/v1/members"
response = requests.get(url, headers={"Authorization": "Bearer YOUR_API_KEY"})

if response.status_code == 200:
    data = response.json()
    members = data["members"]
    for member in members:
        print(member)
else:
    print("Failed to get members. Status code:", response.status_code)

PHP

php
<?php

$url = "https://api.dyntube.com/v1/members?sort=Created:-1";

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOUR_API_KEY"
    ],
]);

$response = curl_exec($ch);
$statusCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($statusCode >= 200 && $statusCode < 300) {
    $data = json_decode($response, true);
    foreach ($data["members"] as $member) {
        echo "Member ID: {$member['id']}, Username: {$member['username']}\n";
    }
} else {
    echo "Failed to get members. Status code: {$statusCode}\n";
    echo $response;
}

?>
  • Create a member to add a new viewer record.
  • Get a member to inspect one member.
  • Get member's plans to review assigned plans.
  • Get member activity to review viewing activity.

Something missing or wrong here? Tell us and we will correct it. New to DynTube? Start with uploading and embedding.