Affiliates: GET /user/{userId}/affiliates

Docs

Affiliates

Accounts affiliated with an organization, as in the Affiliates tab of its profile.

GET/user/{userId}/affiliates

Parameters

userIdpath · string · required
Numeric user ID (digits only, up to 30). To pass a handle instead, use -1 here and set username.
usernamequery · string · optional
Handle, with or without @. When set, it is used instead of userId: the API looks up the ID first, which makes the call a little slower. Still one billed call.
countquery · integer · optional · default 20
Number of users to ask X for, 1 to 100. Other values fall back to 20. X treats it as a hint.
cursorquery · string · optional
Bottom cursor from the previous page. Leave it out for the first page. See Pagination.

Name	In	Type	Required	Default	Description
userId	path	string	yes		Numeric user ID (digits only, up to 30). To pass a handle instead, use -1 here and set username.
username	query	string	no		Handle, with or without @. When set, it is used instead of userId: the API looks up the ID first, which makes the call a little slower. Still one billed call.
count	query	integer	no	20	Number of users to ask X for, 1 to 100. Other values fall back to 20. X treats it as a hint.
cursor	query	string	no		Bottom cursor from the previous page. Leave it out for the first page. See Pagination.

Paginated: pass the bottom cursor of one page as cursor to get the next. Each page is one billed call. See Pagination.

Example request

curl 'https://api.twittrapi.com/user/12/affiliates?count=20' \
  --header 'X-API-KEY: YOUR_API_KEY'

import httpx

# No SDK method for this endpoint yet, so this is a plain HTTP call.
resp = httpx.get(
    "https://api.twittrapi.com/user/12/affiliates",
    headers={"X-API-KEY": "YOUR_API_KEY"},
    params={
        "count": "20",
    },
    timeout=60,
)
data = resp.json()

import { TwittrAPI } from "twittrapi";

const client = new TwittrAPI({ apiKey: process.env.TWITTRAPI_API_KEY });
// No wrapper method for this endpoint yet; client.get() sends the same authenticated GET.
const data = await client.get({
  path: "/user/12/affiliates",
  query: {
    count: "20",
  },
});

curl 'https://twitter-aio.p.rapidapi.com/user/12/affiliates?count=20' \
  --header 'x-rapidapi-key: YOUR_RAPIDAPI_KEY' \
  --header 'x-rapidapi-host: twitter-aio.p.rapidapi.com'

Base URL https://api.twittrapi.com, key in the X-API-KEY header. Python and Node.js use the official SDKs.

Response

Raw JSON of X's UserBusinessProfileTeamTimeline query. Empty for accounts without affiliates.

Simple format (?format=simple or X-Response-Format: simple): Collection of User objects: {data: [User], nextCursor, previousCursor, hasNextPage}. Schema.

Example response coming soon.

In the raw format, field names and nesting come from X and can change without notice. See Response format; the simple format keeps a fixed schema.

Errors

422userId is not numeric, or the username lookup failed.
400userId is -1 and username is missing, the username contains characters X blocks, or the user could not be found.

Errors every endpoint can return (401, 402, 403, 404, 408, 409, 429, 5xx), and which of them are charged, are on the Errors page. Calls that fail with 400, 407, 408, 409 or a 5xx error are refunded.