Scouts
API endpoints for scouts
List scouts
GET /api/v1/scouts
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
organizationId | query | string | No | — |
categoryId | query | string | No | — |
Example request
curl -X GET \
"https://api.example.com/api/v1/scouts?organizationId=<organizationId>&categoryId=<categoryId>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"Response body type
—
Create scout
POST /api/v1/scouts
Example request
curl -X POST \
"https://api.example.com/api/v1/scouts" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"Response body type
—
Get scout
GET /api/v1/scouts/{scoutId}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
scoutId | path | string | Yes | — |
Example request
curl -X GET \
"https://api.example.com/api/v1/scouts/<scoutId>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"Response body type
—
Update scout
PATCH /api/v1/scouts/{scoutId}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
scoutId | path | string | Yes | — |
Example request
curl -X PATCH \
"https://api.example.com/api/v1/scouts/<scoutId>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"Response body type
—
Delete scout
DELETE /api/v1/scouts/{scoutId}
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
scoutId | path | string | Yes | — |
Example request
curl -X DELETE \
"https://api.example.com/api/v1/scouts/<scoutId>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"Response body type
—
List sources for a scout
GET /api/v1/scouts/{scoutId}/sources
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
scoutId | path | string | Yes | — |
Example request
curl -X GET \
"https://api.example.com/api/v1/scouts/<scoutId>/sources" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"Response body type
—
Create source on a scout
POST /api/v1/scouts/{scoutId}/sources
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
scoutId | path | string | Yes | — |
Example request
curl -X POST \
"https://api.example.com/api/v1/scouts/<scoutId>/sources" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"Response body type
—
Get source
GET /api/v1/scouts/{scoutId}/sources/{sourceId}
Example request
curl -X GET \
"https://api.example.com/api/v1/scouts/<scoutId>/sources/<sourceId>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"Response body type
—
Update source
PATCH /api/v1/scouts/{scoutId}/sources/{sourceId}
Example request
curl -X PATCH \
"https://api.example.com/api/v1/scouts/<scoutId>/sources/<sourceId>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"Response body type
—
Delete source
DELETE /api/v1/scouts/{scoutId}/sources/{sourceId}
Example request
curl -X DELETE \
"https://api.example.com/api/v1/scouts/<scoutId>/sources/<sourceId>" \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"Response body type
—
© 2025 Pilfer
All rights reserved.
All rights reserved.