List includes

get

https://{hostname}/papi/v1/includes

Limited availability This operation lists includes available for the current contract and group. Use optional query parameters to only show includes that were modified within a specified time range or on a selected network. If you specify the modifiedSince parameter, contractId and groupId become optional. If you don't identify a contract and group, the operation lists all includes you have access to, modified within a specified time range.

Query Params

modifiedSince

string

Filters properties or includes to those modified within a span of time. Use ISO 8601 duration values, with a limit of 30 days expressed as P30D. Values allow additional detail, such as P10DT12H15M for 10 days, 12 hours, and 15 minutes.

modifiedNetwork

string

enum

Enum Filters and only shows properties or includes that have been modified within a specified period on a selected network, either STAGING, PRODUCTION, or BOTH. You need to specify it along with the modifiedSince query parameter.

Allowed:

contractId

string

required

Unique identifier for the contract. See ID prefixes for details on omitting the value's ctr_ prefix.

groupId

string

required

Unique identifier for the group. See ID prefixes for details on omitting the value's grp_ prefix.

accountSwitchKey

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Headers

PAPI-Use-Prefixes

string

enum

required

Enum Sets whether to represent ID prefixes in response data. Set to false when exchanging PAPI data with other APIs.

Allowed:

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200The response lists all includes available for the requested contract and group.

400Bad request.

401Unauthorized.

403Forbidden.

404Not found.

405Method not allowed.

406Not acceptable.

429Too many requests.

500Internal server error.