RendezvuDocs
    DocsAPIRoster

    Roster

    The hosts you actively work with, with their public profile, commission rate and how many of your campaigns each one has joined.

    ReferenceUpdated 3 min read

    Your roster is the hosts with an active relationship with your brand, the My Hosts list in your console. Each entry carries the host's public profile and your terms with them. Invited hosts who have not joined, and hosts you found in Discover, are not on it.

    Host email, phone and address are never part of a roster entry, and neither are the private tags and notes your team keeps on a host.

    List roster hosts#

    GET/api/brand/v1/roster

    The hosts you actively work with, with their public profile, commission rate and campaign counts. Your team’s private host tags and notes stay in the console.

    Scoperoster:readListpaginated
    Parameters
    • pageintegeroptionaldefault 1
      The page to return, starting at 1. At most 10,000.
    • per_pageintegeroptionaldefault 25
      Items per page, between 1 and 100.
    Returns

    A page of roster relationships. data is an array of objects with these attributes, and the body carries pagination.

    • relationship_idstring
      The id of your relationship with the host.
    • hostobject
      The host’s public profile.
    • statusstring
      The relationship status. Always active here.
    • commission_ratenumber
      This host’s commission rate with you, as a percentage. Your default rate when no custom rate is set.
    • joined_attimestamp
      When the relationship was created.
    • activated_attimestampnullable
      When it became active.
    • campaignsobjectnullable
      The host’s campaigns with you, by state.
    curl 'https://api.rendezvu.co/api/brand/v1/roster?per_page=1' \
      -H "Authorization: Bearer $RENDEZVU_BRAND_API_KEY"
    Response
    {
      "success": true,
      "data": [
        {
          "relationship_id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
          "host": {
            "id": "6f1c2a9e-3b4d-4e1f-9a8b-2c7d5e6f7a81",
            "username": "jordanalpine",
            "first_name": "Jordan",
            "last_name": "Reyes",
            "profile_photo": "https://media.rendezvu.co/6f1c2a9e_profile.jpg",
            "title": "Ultrarunner and coach",
            "intro": "Mountain miles in the Sierra, every season.",
            "discipline": "Trail running",
            "specialty": "Ultramarathon",
            "location": "Truckee, CA",
            "socials": {
              "instagram": "https://instagram.com/jordanalpine",
              "strava": "https://www.strava.com/athletes/000000"
            }
          },
          "status": "active",
          "commission_rate": 12,
          "joined_at": "2026-04-02T16:30:00.000Z",
          "activated_at": "2026-04-03T09:12:00.000Z",
          "campaigns": {
            "status": "active",
            "invited": 1,
            "active": 1,
            "completed": 3,
            "declined": 0
          }
        }
      ],
      "pagination": {
        "page": 1,
        "per_page": 1,
        "total_items": 37,
        "total_pages": 37,
        "has_next": true,
        "has_prev": false
      },
      "_timing": {
        "duration_ms": 42
      }
    }
    Related
    • AnalyticsClicks, views, buy-now clicks and attributed sales for your products, as a summary, a time series and per host. Human traffic only.
    • RecommendationsHosts recommending your products on their public gear lists, with their notes and a host-attributed link per product. Built to render on your site.
    Was this page helpful?