Skip to content
warmupDocs

List tracked accounts

GET
/accounts
curl --request GET \
  --url 'https://api.warmup.social/accounts?platform=instagram&sort=platform&dir=asc' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
platform
string

Example 

instagram

Comma-separated network filter, e.g. instagram or instagram,tiktok. Invalid values are ignored.

sort
string
Allowed values: platform username displayName role followers following posts lastPostAt lastUpdatedAt

Sort key. Invalid values are ignored. Without sort, own accounts come first, then by date added.

dir
string
Allowed values: asc desc

Sort direction. Invalid values are ignored.

Responses

Section titled “Responses”

200

Section titled “200”

Own and competitor accounts of the user.

Media typeapplication/json

One page of results.

object
rows
required
Array<object>
object
platform
required
string
Allowed values: instagram tiktok facebook
username
required
string
displayName
string
avatarUrl
string
biography
string
bioLinks
Array<object>
object
title
required
string
url
required
string
latestFollowers
integer
followersApproximate

True for Facebook — the network rounds follower counts. Absent for other networks.

boolean
latestFollowing
integer
latestPostsCount
integer
isVerified
boolean
lastPostAt
string format: date-time
lastUpdatedAt

Last successful refresh of the profile or posts.

string format: date-time
role
string
Allowed values: own competitor
label
string
status
required
string
Allowed values: pending active no_data not_found failed
statusReason
string
total
required
integer
page
required
integer
pageSize
required
integer
>= 1

Example 

{
  "rows": [
    {
      "platform": "instagram",
      "username": "chillax_nails",
      "role": "own",
      "status": "pending"
    }
  ]
}

401

Section titled “401”

The Bearer token is missing or invalid.

Media typeapplication/json
object
statusCode
required
integer
message
required
One of:
string
error
string
key
additional properties
any

Example 

{
  "statusCode": 400,
  "message": "Invalid request",
  "error": "Bad Request"
}