Scouts

List scouts

GET /api/v1/scouts

Parameters

Name	In	Type	Required	Description
`organizationId`	query	string	No	Organization scope id. Omit for token default; pass an empty value for personal scope where supported.
`categoryId`	query	string	No	—
`include`	query	string	No	Comma-separated relation names to hydrate, or `all`.
`limit`	query	integer	No	Maximum number of items to return.
`offset`	query	integer	No	Number of items to skip.

Example request

curl -X GET \
"https://api.getpilfer.com/api/v1/scouts?organizationId=<organizationId>&categoryId=<categoryId>&include=<include>&limit=<limit>&offset=<offset>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Example response

Status: 200

{
  "data": [
    {
      "_id": "string",
      "name": "string",
      "status": "string",
      "priority": "string",
      "categoryId": "string"
    }
  ]
}

Other statuses: 401, 403.

Response body type

{ data: Scout[] }

Create scout

POST /api/v1/scouts

Example request

curl -X POST \
"https://api.getpilfer.com/api/v1/scouts" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"
-d '{"name":"string","organizationId":"string","categoryId":"string","url":"string","heroImage":"string","priority":"urgent","status":"Archive","estimatedCost":0,"potentialCost":0,"need":0,"urgency":0,"use":0,"longevity":0,"roi":0,"systemFit":0,"emotionalPull":0,"infrastructureFit":0,"activationPotential":0}'

Example response

Status: 201

{
  "data": {
    "_id": "string",
    "name": "string",
    "status": "string",
    "priority": "string",
    "categoryId": "string"
  }
}

Other statuses: 400, 401, 403.

Response body type

{ data: Scout }

Get scout

GET /api/v1/scouts/{id}

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	Convex document id
`include`	query	string	No	Comma-separated relation names to hydrate, or `all`.

Example request

curl -X GET \
"https://api.getpilfer.com/api/v1/scouts/<id>?include=<include>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Example response

Status: 200

{
  "data": {
    "_id": "string",
    "name": "string",
    "status": "string",
    "priority": "string",
    "categoryId": "string"
  }
}

Other statuses: 401, 403, 404.

Response body type

{ data: Scout }

Update scout

PATCH /api/v1/scouts/{id}

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	Convex document id

Example request

curl -X PATCH \
"https://api.getpilfer.com/api/v1/scouts/<id>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"
-d '{"name":"string","categoryId":"string","url":"string","heroImage":"string","priority":"urgent","status":"Archive","estimatedCost":0,"potentialCost":0,"need":0,"urgency":0,"use":0,"longevity":0,"roi":0,"systemFit":0,"emotionalPull":0,"infrastructureFit":0,"activationPotential":0}'

Example response

Status: 200

{
  "data": {
    "_id": "string",
    "name": "string",
    "status": "string",
    "priority": "string",
    "categoryId": "string"
  }
}

Other statuses: 400, 401, 403, 404.

Response body type

{ data: Scout }

Delete scout

DELETE /api/v1/scouts/{id}

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	Convex document id

Example request

curl -X DELETE \
"https://api.getpilfer.com/api/v1/scouts/<id>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Example response

Status: 200

{
  "data": {}
}

Other statuses: 401, 403, 404.

Response body type

{ data: DeleteResult }

List sources for a scout

GET /api/v1/scouts/{scoutId}/sources

Parameters

Name	In	Type	Required	Description
`scoutId`	path	string	Yes	Scout document id
`limit`	query	integer	No	Maximum number of items to return.
`offset`	query	integer	No	Number of items to skip.

Example request

curl -X GET \
"https://api.getpilfer.com/api/v1/scouts/<scoutId>/sources?limit=<limit>&offset=<offset>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Example response

Status: 200

{
  "data": [
    {
      "_id": "string",
      "scoutId": "string",
      "url": "string",
      "title": "string",
      "price": 0
    }
  ]
}

Other statuses: 401, 403, 404.

Response body type

{ data: Source[] }

Create source on a scout

POST /api/v1/scouts/{scoutId}/sources

Parameters

Name	In	Type	Required	Description
`scoutId`	path	string	Yes	Scout document id

Example request

curl -X POST \
"https://api.getpilfer.com/api/v1/scouts/<scoutId>/sources" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"
-d '{"url":"string","title":"string","price":0,"imageUrl":"string","notes":"string"}'

Example response

Status: 201

{
  "data": {
    "_id": "string",
    "scoutId": "string",
    "url": "string",
    "title": "string",
    "price": 0
  }
}

Other statuses: 400, 401, 403, 404.

Response body type

{ data: Source }

Get source

GET /api/v1/scouts/{scoutId}/sources/{sourceId}

Parameters

Name	In	Type	Required	Description
`scoutId`	path	string	Yes	Scout document id
`sourceId`	path	string	Yes	Source document id

Example request

curl -X GET \
"https://api.getpilfer.com/api/v1/scouts/<scoutId>/sources/<sourceId>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Example response

Status: 200

{
  "data": {
    "_id": "string",
    "scoutId": "string",
    "url": "string",
    "title": "string",
    "price": 0
  }
}

Other statuses: 401, 403, 404.

Response body type

{ data: Source }

Update source

PATCH /api/v1/scouts/{scoutId}/sources/{sourceId}

Parameters

Name	In	Type	Required	Description
`scoutId`	path	string	Yes	Scout document id
`sourceId`	path	string	Yes	Source document id

Example request

curl -X PATCH \
"https://api.getpilfer.com/api/v1/scouts/<scoutId>/sources/<sourceId>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"
-d '{"url":"string","title":"string","price":0,"imageUrl":"string","notes":"string"}'

Example response

Status: 200

{
  "data": {
    "_id": "string",
    "scoutId": "string",
    "url": "string",
    "title": "string",
    "price": 0
  }
}

Other statuses: 400, 401, 403, 404.

Response body type

{ data: Source }

Delete source

DELETE /api/v1/scouts/{scoutId}/sources/{sourceId}

Parameters

Name	In	Type	Required	Description
`scoutId`	path	string	Yes	Scout document id
`sourceId`	path	string	Yes	Source document id

Example request

curl -X DELETE \
"https://api.getpilfer.com/api/v1/scouts/<scoutId>/sources/<sourceId>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Example response

Status: 200

{
  "data": {}
}

Other statuses: 401, 403, 404.

Response body type

{ data: DeleteResult }

Add a typed scout relationship

POST /api/v1/scouts/{id}/relationships

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	Convex document id

Example request

curl -X POST \
"https://api.getpilfer.com/api/v1/scouts/<id>/relationships" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"
-d '{"relatedScoutId":"string","type":"parent_of"}'

Example response

Status: 201

{}

Other statuses: 400, 401, 403, 404.

Response body type

{ data: object }

Remove a typed scout relationship by link id

DELETE /api/v1/scouts/{id}/relationships/{linkId}

Parameters

Name	In	Type	Required	Description
`id`	path	string	Yes	Convex document id
`linkId`	path	string	Yes	—

Example request

curl -X DELETE \
"https://api.getpilfer.com/api/v1/scouts/<id>/relationships/<linkId>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

Example response

Status: 200

{
  "data": {}
}

Other statuses: 401, 403, 404.

Response body type

{ data: DeleteResult }