Skip to content
warmupDocs

List projects

GET
/projects
curl --request GET \
  --url https://api.warmup.social/projects \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

The user’s projects and the plan limit.

Media typeapplication/json
object
projects
required
Array<object>
object
id
required
string format: uuid
name
required
string
>= 1 characters <= 80 characters
createdAt
required
string format: date-time
status
required
string
Allowed values: farm active paused archived
gender
required
string
nullable
Allowed values: male female
language
required

BCP 47 language tag.

string
nullable
geo
required

ISO 3166-1 alpha-2 country code.

string
nullable
connections
required
object
facebook
required

The connected account; null — the network is not connected.

object
status
required
string
Allowed values: active needs_reauth revoked
username
required
string
nullable
displayName
required
string
nullable
avatarUrl
required
string
nullable
missingScopes
required
Array<string>
statusReason
required
string
nullable
connectedAt
required
string format: date-time
instagram
required

The connected account; null — the network is not connected.

object
status
required
string
Allowed values: active needs_reauth revoked
username
required
string
nullable
displayName
required
string
nullable
avatarUrl
required
string
nullable
missingScopes
required
Array<string>
statusReason
required
string
nullable
connectedAt
required
string format: date-time
threads
required

The connected account; null — the network is not connected.

object
status
required
string
Allowed values: active needs_reauth revoked
username
required
string
nullable
displayName
required
string
nullable
avatarUrl
required
string
nullable
missingScopes
required
Array<string>
statusReason
required
string
nullable
connectedAt
required
string format: date-time
limits
required
object
used
required
integer
max
required
integer

Example 

{
  "projects": [
    {
      "name": "Nails studio",
      "status": "farm",
      "gender": "male",
      "language": "en-US",
      "geo": "US",
      "connections": {
        "facebook": {
          "status": "active",
          "username": "chillax_nails"
        },
        "instagram": {
          "status": "active",
          "username": "chillax_nails"
        },
        "threads": {
          "status": "active",
          "username": "chillax_nails"
        }
      }
    }
  ],
  "limits": {
    "used": 1,
    "max": 3
  }
}

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"
}