GET ​/api​/v3​/account​/followers

DEPRECATED. Please use /api/v3/account/:id/followers. Gets the list of followers for the current account.

Request

Example Request

{
  "auth_token": "abc1245920feab98ca"
}

Example Parameters

  • auth_token: The user's auth_token obtained by calling the auth API. If provided, the response will indicate follow status for elements in the followers array.
    • Required: no
    • Type: string
    • Example: abc1245920feab98ca

Response

Example Response

{
  "meta": {
    "page": 1,
    "total_pages": 10,
    "per_page": 20,
    "records": 200
  },
  "account": {
    "id": 1821,
    "total_followers_count": 100,
    "total_followed_by_you": 5,
    "partial": true,
    "followers": [
      {
        "id": 29921,
        "username": "goose",
        "full_name": "Nick Bradshaw",
        "avatar": {
          "small": "http://deli.dev/assets/default-avatar-mobile_small-03.png",
          "large": "http://deli.dev/assets/default-avatar-mobile_large-03.png"
        },
        "follows_you": true,
        "you_follow": true
      }
    ]
  },
  "id": 1821,
  "total_followers_count": 100,
  "total_followed_by_you": 5,
  "partial": true,
  "followers": [
    {
      "id": 29921,
      "username": "goose",
      "full_name": "Nick Bradshaw",
      "avatar": {
        "small": "http://deli.dev/assets/default-avatar-mobile_small-03.png",
        "large": "http://deli.dev/assets/default-avatar-mobile_large-03.png"
      },
      "follows_you": true,
      "you_follow": true
    }
  ]
}

Response Parameters

  • meta: Contains paging information about the response

    • Required: no
    • page: The page number (starting at 1)
      • Required: no
      • Type: integer
      • Example: 1
    • total_pages: The total number of pages you can request.
      • Required: no
      • Type: integer
      • Example: 10
    • per_page: The number of records returned in each page.
      • Required: no
      • Type: integer
      • Example: 20
    • records: The total number of records available.
      • Required: no
      • Type: integer
      • Example: 200
  • account: A partial update to the account including following information.

    • Required: yes
    • id: The id of the user account.
      • Required: yes
      • Type: integer
      • Example: 1821
    • totalfollowerscount: The total number of followers for this account.
      • Required: yes
      • Type: integer
      • Example: 100
    • totalfollowedby_you: The number of followers that are also followed by the requesting account.
      • Required: no
      • Type: integer
      • Example: 5
    • partial: This does not include the full object.
      • Required: yes
      • Type: boolean
      • Example: true
    • followers: A list of the account's followers.

      • Required: yes
      • Type: array
      • Items

        • Required: no
        • id: The id of the followed account.
          • Required: yes
          • Type: integer
          • Example: 29921
        • username: The followed account's username.
          • Required: yes
          • Type: string
          • Example: goose
        • full_name: The follower account's full name.
          • Required: yes
          • Type: string
          • Example: Nick Bradshaw
        • avatar: The avatar of the followed account. Pass the DELI-RETINA header to receive high-resolution versions of these.

          • Required: yes
          • small: The small avatar URL, useful when displaying in lists.
          • large: The large avatar URL, useful when displaying on a single profile screen.
        • follows_you: Indicates whether or not the user follows the requesting account.

          • Required: yes
          • Type: boolean
          • Example: true
        • you_follow: This key is left in for consistency with other responses. Will always be true for this endpoint.

          • Required: yes
          • Type: boolean
          • Example: true
  • id: The id of the user account.

    • Required: yes
    • Type: integer
    • Example: 1821
  • totalfollowerscount: The total number of followers for this account.

    • Required: yes
    • Type: integer
    • Example: 100
  • totalfollowedby_you: The number of followers that are also followed by the requesting account.

    • Required: no
    • Type: integer
    • Example: 5
  • partial: This does not include the full object.

    • Required: yes
    • Type: boolean
    • Example: true
  • followers: A list of the account's followers.

    • Required: yes
    • Type: array
    • Items

      • Required: no
      • id: The id of the followed account.
        • Required: yes
        • Type: integer
        • Example: 29921
      • username: The followed account's username.
        • Required: yes
        • Type: string
        • Example: goose
      • full_name: The follower account's full name.
        • Required: yes
        • Type: string
        • Example: Nick Bradshaw
      • avatar: The avatar of the followed account. Pass the DELI-RETINA header to receive high-resolution versions of these.

        • Required: yes
        • small: The small avatar URL, useful when displaying in lists.
          • Required: yes
          • Type: string
          • Format: uri
          • Example: http://deli.dev/assets/default-avatar-mobile_small-03.png
        • large: The large avatar URL, useful when displaying on a single profile screen.
          • Required: yes
          • Type: string
          • Format: uri
          • Example: http://deli.dev/assets/default-avatar-mobile_large-03.png
      • follows_you: Indicates whether or not the user follows the requesting account.

        • Required: yes
        • Type: boolean
        • Example: true
      • you_follow: This key is left in for consistency with other responses. Will always be true for this endpoint.

        • Required: yes
        • Type: boolean
        • Example: true

Response Codes

Successful Response Codes

  • 200: Successful response.

Failure Response Codes

  • 401: Unauthorized request. Indicates a missing or invalid auth_token. This endpoint requires an admin account.