Returns all channels user follows
slug
required
|
string
slug of user to search |
[- {
- "user": 2,
- "followed_channel": {
- "id": 2,
- "user": 1,
- "title": "Channel 2",
- "description": "example description",
- "slug": "channel-2",
- "follower_count": 2,
- "date_created": "2020-01-01T17:00:00.000Z",
- "date_updated": "2020-01-01T17:00:00.000Z"
}, - "date_created": "2022-01-01T17:00:00.000Z"
}, - {
- "user": 2,
- "followed_channel": {
- "id": 1,
- "user": 6,
- "title": "Chann3l 6",
- "description": "example description",
- "slug": "channel-6",
- "follower_count": 10,
- "date_created": "2020-01-01T17:00:00.000Z",
- "date_updated": "2020-01-01T17:00:00.000Z"
}, - "date_created": "2022-01-02T17:00:00.000Z"
}
]
{- "id": 1,
- "slug": "test-user-1",
- "first_name": "Test",
- "last_name": "User 1",
- "full_name": "Test User 1",
- "email": "test@email.com",
- "avatar": "image.jpg",
- "following_count": 0,
- "follower_count": 0,
- "role": "user",
- "enabled": true,
- "locked": false
}
User must be logged in and have administrative privileges to preform action. Optional parameters for user pagination.
last_id |
string
ID of previous pagination |
limit |
string
Number of users to return |
[- {
- "id": 2,
- "slug": "second-user",
- "first_name": "second",
- "last_name": "last",
- "full_name": "Second User",
- "email": "second@email.com",
- "avatar": "image.jpg",
- "following_count": 3,
- "follower_count": 4,
- "role": "user",
- "enabled": true,
- "locked": false
}, - {
- "id": 5,
- "slug": "firth-user",
- "first_name": "fifth",
- "last_name": "last",
- "full_name": "Fifth User",
- "email": "fifth@email.com",
- "avatar": "image.jpg",
- "following_count": 0,
- "follower_count": 1,
- "role": "user",
- "enabled": true,
- "locked": false
}
]
Returns a single user
id
required
|
string
ID of user to return |
{- "id": 1,
- "slug": "first-user",
- "first_name": "first",
- "last_name": "user",
- "full_name": "First User",
- "email": "first@email.com",
- "avatar": "image.jpg",
- "following_count": 5,
- "follower_count": 1,
- "role": "user",
- "enabled": true,
- "locked": false
}
Returns a single user
slug
required
|
string
Slug of user to return |
{- "id": 1,
- "slug": "first-user",
- "first_name": "first",
- "last_name": "last",
- "full_name": "First User",
- "email": "first@email.com",
- "avatar": "image.jpg",
- "following_count": 5,
- "follower_count": 1,
- "role": "user",
- "enabled": true,
- "locked": false
}
Returns all users following particular user
slug
required
|
string
slug of user to search |
[- {
- "following_user": {
- "id": 20,
- "slug": "following-user",
- "first_name": "following",
- "last_name": "user",
- "full_name": "Following User",
- "email": "following@email.com",
- "avatar": "image.jpg",
- "following_count": 1,
- "follower_count": 1,
- "role": "user",
- "enabled": true,
- "locked": false
}, - "followed_user": 2,
- "date_created": "2023-02-12T17:00:00.000Z"
}
]
Returns all users that a particular user follows
slug
required
|
string
slug of user to search |
[- {
- "following_user": 4,
- "followed_user": {
- "id": 20,
- "slug": "followed-user",
- "first_name": "followed",
- "last_name": "user",
- "full_name": "Followed User",
- "email": "followed@email.com",
- "avatar": "image.jpg",
- "following_count": 2,
- "follower_count": 2,
- "role": "user",
- "enabled": true,
- "locked": false
}, - "date_created": "2019-04-15T17:00:00.000Z"
}
]
{- "id": 1,
- "slug": "test-user-1",
- "first_name": "Test",
- "last_name": "User 1",
- "full_name": "Test User 1",
- "email": "test@email.com",
- "avatar": "image.jpg",
- "following_count": 0,
- "follower_count": 0,
- "role": "user",
- "enabled": true,
- "locked": false,
- "token": "token12345"
}
Returns relevant users
name
required
|
string
Keyword to search |
[- {
- "id": 2,
- "slug": "second-user",
- "first_name": "second",
- "last_name": "last",
- "full_name": "Second User",
- "email": "second@email.com",
- "avatar": "image.jpg",
- "following_count": 3,
- "follower_count": 4,
- "role": "user",
- "enabled": true,
- "locked": false
}, - {
- "id": 5,
- "slug": "firth-user",
- "first_name": "fifth",
- "last_name": "last",
- "full_name": "Fifth User",
- "email": "fifth@email.com",
- "avatar": "image.jpg",
- "following_count": 0,
- "follower_count": 1,
- "role": "user",
- "enabled": true,
- "locked": false
}
]
[- {
- "id": 1,
- "user": 2,
- "title": "Channel 1",
- "description": "example description",
- "slug": "channel-1",
- "follower_count": 2,
- "date_created": "2020-01-01T17:00:00.000Z",
- "date_updated": "2020-01-01T17:00:00.000Z"
}, - {
- "id": 2,
- "user": {
- "id": 1,
- "slug": "first-user",
- "first_name": "First",
- "last_name": "User",
- "full_name": "First User"
}, - "title": "Channel 2",
- "description": "example description",
- "slug": "channel-2",
- "follower_count": 6,
- "date_created": "2020-02-01T17:00:00.000Z",
- "date_updated": "2020-02-01T17:00:00.000Z"
}
]
Optional parameters for block pagination
id
required
|
string
ID of channel to return |
last_id |
string
ID of previous pagination |
limit |
string
Number of blocks to return |
{- "total": 0,
- "last_id": null,
- "data": {
- "id": 1,
- "user": 2,
- "title": "Test Channel 1",
- "description": "example description",
- "slug": "test-channel-1",
- "follower_count": 5,
- "date_created": "2020-01-01T17:00:00.000Z",
- "date_updated": "2020-01-01T17:00:00.000Z",
- "block": [ ]
}
}
Returns all user channels
id
required
|
string
ID of user to search |
[- {
- "total": 4,
- "last_id": null,
- "data": [
- {
- "channel": {
- "id": 1,
- "user": 2,
- "title": "Test Channel 1",
- "description": "example description",
- "slug": "test-channel-1",
- "follower_count": 5,
- "date_created": "2020-01-01T17:00:00.000Z",
- "date_updated": "2020-01-01T17:00:00.000Z"
}, - "blocks": [ ],
- "total_blocks": 0
}
]
}
]
Optional parameters for block pagination
slug
required
|
string
Slug of channel to return |
last_id |
string
ID of previous pagination |
limit |
string
Number of blocks to return |
{- "total": 0,
- "last_id": null,
- "data": {
- "id": 1,
- "user": {
- "id": 1,
- "slug": "first-user",
- "full_name": "First User"
}, - "title": "Test Channel 1",
- "description": "example description",
- "slug": "test-channel-1",
- "follower_count": 5,
- "date_created": "2020-01-01T17:00:00.000Z",
- "date_updated": "2020-01-01T17:00:00.000Z",
- "block": [ ]
}
}
Returns all users following particular channel
slug
required
|
string
slug of channel to search |
[- {
- "user": {
- "id": 1,
- "slug": "first-user",
- "first_name": "first",
- "last_name": "user",
- "full_name": "First User",
- "email": "first@email.com",
- "avatar": "image.jpg",
- "following_count": 5,
- "follower_count": 1,
- "role": "user",
- "enabled": true,
- "locked": false
}, - "followed_channel": 5,
- "date_created": "2022-01-02T17:00:00.000Z"
}, - {
- "user": {
- "id": 2,
- "slug": "second-user",
- "first_name": "second",
- "last_name": "user",
- "full_name": "Second User",
- "email": "second@email.com",
- "avatar": "image.jpg",
- "following_count": 2,
- "follower_count": 2,
- "role": "user",
- "enabled": true,
- "locked": false
}, - "followed_channel": 5,
- "date_created": "2022-01-03T17:00:00.000Z"
}
]
Returns relevant channels
title
required
|
string
Keyword to search |
[- {
- "id": 3,
- "user": {
- "id": 1,
- "slug": "first-user",
- "first_name": "First",
- "last_name": "User",
- "full_name": "First User"
}, - "title": "Channel 3",
- "description": "example description",
- "slug": "channel-3",
- "follower_count": 0,
- "date_created": "2020-02-01T17:00:00.000Z",
- "date_updated": "2020-02-01T17:00:00.000Z"
}, - {
- "id": 2,
- "user": {
- "id": 1,
- "slug": "first-user",
- "first_name": "First",
- "last_name": "User",
- "full_name": "First User"
}, - "title": "Channel 2",
- "description": "example description",
- "slug": "channel-2",
- "follower_count": 6,
- "date_created": "2020-02-01T17:00:00.000Z",
- "date_updated": "2020-02-01T17:00:00.000Z"
}
]
User must be logged in and have channel ownership to preform action
id
required
|
string
ID of channel to create block in |
{- "id": 2,
- "unique_id": "abc123",
- "user": 7,
- "channels": [ ],
- "title": "Test Block 1",
- "description": "example description",
- "source_url": "source.com",
- "image_url": "image.jpg",
- "date_created": "2020-01-01T17:00:00.000Z",
- "date_updated": "2020-01-01T17:00:00.000Z"
}
User must be logged in and have administrative privileges to preform action
[- {
- "id": 5,
- "unique_id": "abc123",
- "user": 4,
- "title": "Block 5",
- "description": "example description",
- "source_url": "source.com",
- "image_url": "image.jpg",
- "date_created": "2020-01-01T17:00:00.000Z",
- "date_updated": "2020-01-01T17:00:00.000Z"
}, - {
- "id": 8,
- "unique_id": "abc567",
- "user": 6,
- "title": "Block 8",
- "description": "example description",
- "source_url": "source.com",
- "image_url": "image.jpg",
- "date_created": "2021-05-15T17:00:00.000Z",
- "date_updated": "2021-05-15T17:00:00.000Z"
}
]
Returns all user blocks
id
required
|
string
ID of user to search |
[- {
- "id": 1,
- "unique_id": "abc123",
- "user": 2,
- "title": "Block 1",
- "description": "example description",
- "source_url": "source.com",
- "image_url": "image.jpg",
- "date_created": "2020-01-01T17:00:00.000Z",
- "date_updated": "2020-01-01T17:00:00.000Z"
}, - {
- "id": 2,
- "unique_id": "abc567",
- "user": 2,
- "title": "Block 2",
- "description": "example description",
- "source_url": "source.com",
- "image_url": "image.jpg",
- "date_created": "2021-05-15T17:00:00.000Z",
- "date_updated": "2021-05-15T17:00:00.000Z"
}
]
Returns a single block
id
required
|
string
ID of block to return |
{- "id": 2,
- "unique_id": "abc123",
- "user": 7,
- "channels": [
- {
- "id": 2,
- "user": {
- "id": 1,
- "slug": "first-user",
- "first_name": "First",
- "last_name": "User",
- "full_name": "First User"
}, - "title": "Channel 2",
- "description": "example description",
- "slug": "channel-2",
- "follower_count": 6,
- "date_created": "2020-02-01T17:00:00.000Z",
- "date_updated": "2020-02-01T17:00:00.000Z"
}
], - "title": "Test Block 1",
- "description": "example description",
- "source_url": "source.com",
- "image_url": "image.jpg",
- "date_created": "2020-01-01T17:00:00.000Z",
- "date_updated": "2020-01-01T17:00:00.000Z"
}
Returns relevant blocks
title
required
|
string
Keyword to search |
[- {
- "id": 2,
- "unique_id": "abc123",
- "user": 7,
- "channels": [
- {
- "id": 2,
- "user": {
- "id": 1,
- "slug": "first-user",
- "first_name": "First",
- "last_name": "User",
- "full_name": "First User"
}, - "title": "Channel 2",
- "description": "example description",
- "slug": "channel-2",
- "follower_count": 6,
- "date_created": "2020-02-01T17:00:00.000Z",
- "date_updated": "2020-02-01T17:00:00.000Z"
}
], - "title": "Test Block 1",
- "description": "example description",
- "source_url": "source.com",
- "image_url": "image.jpg",
- "date_created": "2020-01-01T17:00:00.000Z",
- "date_updated": "2020-01-01T17:00:00.000Z"
}
]
User must be logged in and have channel ownership to preform action
id
required
|
string
ID of block to connect |
channel
required
|
string
Keyword to search |
{- "id": 2,
- "unique_id": "abc123",
- "user": 7,
- "channels": [ ],
- "title": "Test Block 1",
- "description": "example description",
- "source_url": "source.com",
- "image_url": "image.jpg",
- "date_created": "2020-01-01T17:00:00.000Z",
- "date_updated": "2020-01-01T17:00:00.000Z"
}
User must be logged in and have channel ownership to preform action
id
required
|
string
ID of block to connect |
channel
required
|
string
Keyword to search |
{- "message": "Block has been disconnected from the channel."
}
Optional parameters for channel and block pagination
channel_lastID |
string
Last channel id for pagination |
block_lastID |
string
Last block id for pagination |
limit |
string
Limit number of results to return |
{- "total": 2,
- "channel_total": 1,
- "block_total": 1,
- "channel_lastID": null,
- "block_lastID": null,
- "data": [
- {
- "id": 2,
- "unique_id": "abc123",
- "user": 7,
- "channels": [
- {
- "id": 2,
- "user": {
- "id": 1,
- "slug": "first-user",
- "first_name": "First",
- "last_name": "User",
- "full_name": "First User"
}, - "title": "Channel 2",
- "description": "example description",
- "slug": "channel-2",
- "follower_count": 6,
- "date_created": "2020-02-01T17:00:00.000Z",
- "date_updated": "2020-02-01T17:00:00.000Z"
}
], - "title": "Test Block 1",
- "description": "example description",
- "source_url": "source.com",
- "image_url": "image.jpg",
- "date_created": "2020-01-01T17:00:00.000Z",
- "date_updated": "2020-01-01T17:00:00.000Z"
}
]
}
Returns an array of feed items
id
required
|
string
ID of user to search |
[- {
- "user": {
- "id": 1,
- "slug": "test-user-1",
- "first_name": "Test",
- "last_name": "User 1",
- "full_name": "Test User 1"
}, - "timestamp": "2020-01-01T17:00:00.000Z",
- "data_type": "Block",
- "action_type": "Connected",
- "data": {
- "block": {
- "id": 2,
- "unique_id": "abc123",
- "user": 7,
- "channels": [
- {
- "id": 2,
- "user": 5,
- "title": "Channel 8",
- "description": "example description",
- "slug": "channel-8",
- "follower_count": 7,
- "date_created": "2020-02-01T17:00:00.000Z",
- "date_updated": "2020-02-01T17:00:00.000Z"
}
], - "title": "Test Block 1",
- "description": "example description",
- "source_url": "source.com",
- "image_url": "image.jpg",
- "date_created": "2020-01-01T17:00:00.000Z",
- "date_updated": "2020-01-01T17:00:00.000Z"
}, - "channel": {
- "id": 2,
- "user": {
- "id": 1,
- "slug": "first-user",
- "first_name": "First",
- "last_name": "User",
- "full_name": "First User",
- "avatar": "image.jpg"
}, - "title": "Channel 2",
- "description": "example description",
- "slug": "channel-2",
- "follower_count": 6,
- "date_created": "2020-02-01T17:00:00.000Z",
- "date_updated": "2020-02-01T17:00:00.000Z",
- "blocks": [ ],
- "users_following": [ ]
}
}
}
]