Sources

Get a source

Returns a single source. The source must belong to the active project.

GET /api/v1/sources/{source}

Path parameters

Name Type Required Description
source integer Required

The numeric ID of the source.

Query parameters

Name Type Required Description
include string Optional

A comma-separated list of related resources to include in the response. Allowed values: project, project.organization.

Response

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 null if it has not yet been analyzed.

created_at datetime

When the source was created.

updated_at datetime

When the source was last updated.