Sign in

v1

latestOpenAPI 3.1.02026-07-24318141.2 MB

List Profile Relationships

get/profile-relationships/

Query parameters

client_idstring required

The Application's Client ID

relationship_type_keystring

The key of the Relationship Type. Example: follow

from_profile_idstring

The ID of the user profile on the "from" side of the relationship.

to_profile_idstring

The ID of the user profile on the "to" side of the relationship.

sincestring date

Filter for relationships created since this ISO-8601 date/time.

untilstring date

Filter for relationships created until this ISO-8601 date/time.

orderingstring

By default, results are returned ordered by created_at in ascending order. Change to -created_at to receive most recent results first.

Response

200

countinteger
{"stackTrail":"paths:/profile-relationships/:get:responses:200:content:application/json:schema:properties:next","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/profile-relationships/:get:responses:200:content:application/json:schema:properties:previous","oasType":"schema","type":"unknown"}

Example response

{
  "count": 2,
  "results": [
    {
      "id": "d659c88f-0edf-47d7-882a-8d6184c76126",
      "url": "https://cf-blast.livelikecdn.com/api/v1/profile-relationships/d659c88f-0edf-47d7-882a-8d6184c76126/",
      "created_at": "2023-02-21T15:44:58.204862Z",
      "relationship_type": {
        "id": "7da7c4c8-6e42-4d50-8d32-aa0be0bd0933",
        "url": "https://cf-blast.livelikecdn.com/api/v1/profile-relationship-types/7da7c4c8-6e42-4d50-8d32-aa0be0bd0933/",
        "created_at": "2023-02-21T14:43:30.325594Z",
        "client_id": "ApwNvZVpqAwHdWGxmdOde5W4ehMqqRkbuRPfu9OP",
        "name": "Follow",
        "key": "follow"
      },
      "from_profile": {
        "id": "c8b1d0e0-8e90-4094-b74a-1b4888002352",
        "url": "https://cf-blast.livelikecdn.com/api/v1/profiles/c8b1d0e0-8e90-4094-b74a-1b4888002352/",
        "created_at": "2021-05-12T02:49:52Z",
        "nickname": "User c2c679c3-e8ef-4d2d-9859-b83db3b4464b",
        "badges_url": "https://cf-blast.livelikecdn.com/api/v1/profiles/c8b1d0e0-8e90-4094-b74a-1b4888002352/badges/",
        "badge_progress_url": "https://cf-blast.livelikecdn.com/api/v1/profiles/c8b1d0e0-8e90-4094-b74a-1b4888002352/badge-progress/",
        "subscribe_channel": "profile.c8b1d0e0-8e90-4094-b74a-1b4888002352",
        "chat_room_memberships_url": "https://cf-blast.livelikecdn.com/api/v1/profiles/c8b1d0e0-8e90-4094-b74a-1b4888002352/chat-room-memberships/",
        "reward_item_credit_url": "https://cf-blast.livelikecdn.com/api/v1/profiles/c8b1d0e0-8e90-4094-b74a-1b4888002352/reward-item-credits/",
        "reward_item_debit_url": "https://cf-blast.livelikecdn.com/api/v1/profiles/c8b1d0e0-8e90-4094-b74a-1b4888002352/reward-item-debits/",
        "reward_item_balances_url": "https://cf-blast.livelikecdn.com/api/v1/profiles/c8b1d0e0-8e90-4094-b74a-1b4888002352/reward-item-balances/",
        "reward_item_transfer_url": "https://cf-blast.livelikecdn.com/api/v1/profiles/c8b1d0e0-8e90-4094-b74a-1b4888002352/reward-item-transfers/",
        "block_profile_url": "https://cf-blast.livelikecdn.com/api/v1/profile-blocks/",
        "blocked_profiles_template_url": "https://cf-blast.livelikecdn.com/api/v1/profile-blocks/?blocked_profile_id={blocked_profile_id}",
        "blocked_profile_ids_url": "https://cf-blast.livelikecdn.com/api/v1/blocked-profile-ids/",
        "leaderboards_url": "https://cf-blast.livelikecdn.com/api/v1/profiles/c8b1d0e0-8e90-4094-b74a-1b4888002352/leaderboards/",
        "leaderboard_views_url": "https://cf-blast.livelikecdn.com/api/v1/profiles/c8b1d0e0-8e90-4094-b74a-1b4888002352/leaderboard-views/",
        "earned_badges_url": "https://cf-blast.livelikecdn.com/api/v1/earned-badges/?profile_id=c8b1d0e0-8e90-4094-b74a-1b4888002352"
      },
      "to_profile": {
        "id": "cb4a1bc8-fa5a-41e8-8add-ae48116ae788",
        "url": "https://cf-blast.livelikecdn.com/api/v1/profiles/cb4a1bc8-fa5a-41e8-8add-ae48116ae788/",
        "created_at": "2022-04-22T10:28:08Z",
        "nickname": "Loyal Champion",
        "badges_url": "https://cf-blast.livelikecdn.com/api/v1/profiles/cb4a1bc8-fa5a-41e8-8add-ae48116ae788/badges/",
        "badge_progress_url": "https://cf-blast.livelikecdn.com/api/v1/profiles/cb4a1bc8-fa5a-41e8-8add-ae48116ae788/badge-progress/",
        "subscribe_channel": "profile.cb4a1bc8-fa5a-41e8-8add-ae48116ae788",
        "chat_room_memberships_url": "https://cf-blast.livelikecdn.com/api/v1/profiles/cb4a1bc8-fa5a-41e8-8add-ae48116ae788/chat-room-memberships/",
        "reward_item_credit_url": "https://cf-blast.livelikecdn.com/api/v1/profiles/cb4a1bc8-fa5a-41e8-8add-ae48116ae788/reward-item-credits/",
        "reward_item_debit_url": "https://cf-blast.livelikecdn.com/api/v1/profiles/cb4a1bc8-fa5a-41e8-8add-ae48116ae788/reward-item-debits/",
        "reward_item_balances_url": "https://cf-blast.livelikecdn.com/api/v1/profiles/cb4a1bc8-fa5a-41e8-8add-ae48116ae788/reward-item-balances/",
        "reward_item_transfer_url": "https://cf-blast.livelikecdn.com/api/v1/profiles/cb4a1bc8-fa5a-41e8-8add-ae48116ae788/reward-item-transfers/",
        "block_profile_url": "https://cf-blast.livelikecdn.com/api/v1/profile-blocks/",
        "blocked_profiles_template_url": "https://cf-blast.livelikecdn.com/api/v1/profile-blocks/?blocked_profile_id={blocked_profile_id}",
        "blocked_profile_ids_url": "https://cf-blast.livelikecdn.com/api/v1/blocked-profile-ids/",
        "leaderboards_url": "https://cf-blast.livelikecdn.com/api/v1/profiles/cb4a1bc8-fa5a-41e8-8add-ae48116ae788/leaderboards/",
        "leaderboard_views_url": "https://cf-blast.livelikecdn.com/api/v1/profiles/cb4a1bc8-fa5a-41e8-8add-ae48116ae788/leaderboard-views/",
        "earned_badges_url": "https://cf-blast.livelikecdn.com/api/v1/earned-badges/?profile_id=cb4a1bc8-fa5a-41e8-8add-ae48116ae788"
      }
    }
  ]
}