Watch a company board

POST

/api/watchlist

curl --request POST \
  --url http://127.0.0.1:8765/api/watchlist \
  --header 'Content-Type: application/json' \
  --data '{ "url": "https://boards.greenhouse.io/acme" }'

Add a company board by its posting or board URL.

Request Body^required

Media typeapplication/json

object

url

required

A board or posting URL on a supported ATS.

string

Example

{
  "url": "https://boards.greenhouse.io/acme"
}

Responses

200

Success.

Media typeapplication/json

object

schema_version

required

Allowed value: scout-watchlist-add-response:1

key

additional properties

any

Example

{
  "created": true,
  "entry": {},
  "schema_version": "scout-watchlist-add-response:1"
}

403

Forbidden / forbidden_origin: loopback peer and Host 127.0.0.1:<port> or localhost:<port> only (Origin too on writes).

Media typeapplication/json

object

error

required

object

allowed_keys

Array<string>

code

required

string

message

required

string

key

additional properties

any

Example^generated

{
  "error": {
    "allowed_keys": [
      "example"
    ],
    "code": "example",
    "message": "example"
  }
}

404

Not_found

Media typeapplication/json

object

error

required

object

allowed_keys

Array<string>

code

required

string

message

required

string

key

additional properties

any

Example

{
  "error": {
    "code": "not_found",
    "message": "..."
  }
}

415

Unsupported_media_type: writes need Content-Type: application/json.

Media typeapplication/json

object

error

required

object

allowed_keys

Array<string>

code

required

string

message

required

string

key

additional properties

any

Example^generated

{
  "error": {
    "allowed_keys": [
      "example"
    ],
    "code": "example",
    "message": "example"
  }
}

422

Unknown_key, invalid_value

Media typeapplication/json

object

error

required

object

allowed_keys

Array<string>

code

required

string

message

required

string

key

additional properties

any

Example

{
  "error": {
    "code": "unknown_key",
    "message": "..."
  }
}