Sources
List sources
Returns every cited source in the active project. The response is paginated.
GET
/api/v1/sources
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
| page | integer | Optional | The page number to return. Defaults to |
| per_page | integer | Optional | The number of items per page. Defaults to |
| sort_by | string | Optional | The column to sort by. Defaults to |
| sort_order | string | Optional | The direction to sort by. Each endpoint has its own default. |
| include | string | Optional | A comma-separated list of related resources to include in the response. Allowed values: |
Response
Response schema
| Field | Type | Description |
|---|---|---|
| data | Source[] | |
| links | PaginationLinks | |
| meta | PaginationMeta |
The source object
| Field | Type | Description |
|---|---|---|
| id | integer | The unique ID of the source. |
| project_id | integer | The ID of the project the source belongs to. |
| domain | string | The domain of the cited URL. |
| type | string | The source type, as classified by Pineprompt. |
| playbook | string | The playbook category the source falls under. |
| analyzed_at | datetime | When the source was most recently analyzed, or |
| created_at | datetime | When the source was created. |
| updated_at | datetime | When the source was last updated. |