Globals

For most endpoints, the Playbooks API will accept the following query parameters to sort and modify your results.

Each resource will then accept table-specific parameters, such as status=active, for filtering and other response modifications.

Please review the documentation for each resource to learn more about the table-specific parameters they'll accept.


Standard Parameters

Attribute
Type
Description
sortPropstringSort results by a specific property
sortValuestringSort results by a specific value
includestringComma separated string of related data to include

Resource Specific Parameters

Attribute
Type
Description
StatusstringFilter results by status
Examples
GET "/repos?status=active" GET "/repos?sortProp=name&sortValue=asc" GET "/repos?include=framework,language,license"

2024 © Playbooks, Inc