Get a project

GET

/projects/{id}

const url = 'https://api.warmup.social/projects/00000000-0000-0000-0000-000000000000';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

A project that belongs to another user and a missing project look the same — both return 404.

Authorizations

bearerAuth

Parameters

Path Parameters

required

string format: uuid

Example

00000000-0000-0000-0000-000000000000

Project UUID.

Responses

200

The project with its connections and the plan limit.

application/json

object

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

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

400

Invalid request.

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

401

The Bearer token is missing or invalid.

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

404

The requested resource was not found.

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