> For the complete documentation index, see [llms.txt](https://integrations.impact.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://integrations.impact.com/brand-api-reference/brand-api-reference-v11/reference/programs/programs.md).

# Programs

## List all programs

> Returns a list of the programs for your account, sorted by program Id.

```json
{"openapi":"3.1.0","info":{"title":"Brand Programs API","version":"v11"},"servers":[{"url":"https://api.impact.com"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"schemas":{"Program":{"type":"object","properties":{"Id":{"type":"integer","description":"The unique identifier for the program."},"Name":{"type":"string","description":"The display name of the program."},"State":{"type":"string","description":"The current state of the program.","enum":["ACTIVE","AWAITING_REVIEW","CANCELLED","CLOSED","DEACTIVATED","DELINQUENT","REJECTED","SETUP","SETUP_COMPLETE"]},"Categories":{"type":"object","description":"The program's category classifications.","properties":{"PrimaryCategory":{"type":"string","description":"The program's primary category."},"PrimarySubCategories":{"type":"array","description":"Subcategories under the primary category.","items":{"type":"string"}},"AdditionalCategory":{"type":"string","nullable":true,"description":"An additional category for the program, if any."},"AdditionalSubCategories":{"type":"array","description":"Subcategories under the additional category.","items":{"type":"string"}}}},"ShortDescription":{"type":"string","description":"A short description of the program."},"LongDescription":{"type":"string","description":"A long description of the program."},"ListInMarketplace":{"type":"boolean","description":"Whether the program is listed in the impact.com partner marketplace."},"DisplayServicingAgency":{"type":"boolean","description":"Whether the servicing agency is displayed publicly."},"Rating":{"type":"integer","description":"The program's rating."},"SearchKeywords":{"type":"string","description":"Keywords used to surface the program in marketplace search."},"ShippingRegions":{"type":"array","description":"Regions where the brand ships.","items":{"type":"string"}},"Resources":{"type":"object","description":"Links to brand-provided resources.","properties":{"CompanyHomepage":{"type":"string","format":"uri","description":"The company homepage URL."},"ExampleLandingPage":{"type":"string","format":"uri","description":"An example landing page URL."},"InformationPage":{"type":"string","format":"uri","description":"An information page URL."},"AdditionalRelatedLinks":{"type":"array","description":"Additional links related to the program.","items":{"type":"object","properties":{"LinkType":{"type":"string","description":"The type of link.","enum":["URL","PDF"]},"LinkDisplayName":{"type":"string","description":"Display name for the link."},"LinkUrl":{"type":"string","format":"uri","description":"The URL of the link."}}}}}},"CompanyContacts":{"type":"array","description":"Company contacts for the program.","items":{"type":"object","properties":{"FirstName":{"type":"string","description":"The contact's first name."},"LastName":{"type":"string","description":"The contact's last name."},"EmailAddress":{"type":"string","description":"The contact's email address."},"PhoneNumber":{"type":"string","description":"The contact's phone number."}}}},"GiftCardPayouts":{"type":"boolean","description":"Whether gift card payouts are enabled."},"TrademarkBidding":{"type":"boolean","description":"Whether partners are allowed to bid on the brand's trademark terms."},"ThirdPartyImpressionPixel":{"type":"string","description":"A third-party impression tracking pixel."},"MobileReadyAds":{"type":"boolean","description":"Whether the program supports mobile-ready ads."},"DisplayFutureAds":{"type":"boolean","description":"Whether to display ads that aren't yet active."},"PromoCodeTracking":{"type":"boolean","description":"Whether promo code tracking is enabled."},"TrackingDomain":{"type":"string","description":"The tracking domain used for this program."},"SiteDefinition":{"type":"string","description":"The site definition for the program."},"ImpressionTracking":{"type":"boolean","description":"Whether impression tracking is enabled."},"ViewThroughCrediting":{"type":"boolean","description":"Whether view-through crediting is enabled."},"IdentityMatching":{"type":"string","description":"The identity matching strategy.","enum":["NONE","ACCOUNT","IR_CONSORTIUM"]},"GatewayTrackingSettings":{"$ref":"#/components/schemas/GatewayTrackingSettings","description":"Settings for gateway tracking."},"DirectTrackingSettings":{"type":"object","description":"Settings for direct tracking.","properties":{"UnidentifiedName":{"type":"string","description":"Name used for unidentified traffic."},"SessionWindowLength":{"type":"string","description":"The session window length."}}},"Uri":{"type":"string","format":"uri-reference","description":"The unique reference to this program in the impact.com API."}}},"GatewayTrackingSettings":{"type":"object","properties":{"DefaultLandingPage":{"type":"string","format":"uri","description":"The default landing page URL."},"MediaPartnerTrackingTemplate":{"type":"string","description":"Tracking template applied to media partner links."},"CampaignTrackingTemplate":{"type":"string","description":"Tracking template applied to campaign links."},"SSLSupport":{"type":"boolean","description":"Whether SSL is supported for tracking links."},"DeepLinking":{"type":"boolean","description":"Whether deep linking is enabled."},"DeepLinkDomains":{"type":"string","description":"Comma-separated list of domains for deep linking."},"ThirdPartyGatewayUrl":{"type":"string","format":"uri","description":"A third-party gateway URL for tracking."},"ThirdPartyGatewayQueryStringParameters":{"type":"string","description":"Query string parameters for the third-party gateway."},"UniqueClickWindowLength":{"type":"string","description":"The length of the unique click window.","enum":["1m","5m","15m","30m","1h","6h","12h","24h"]},"UniqueClickWindowType":{"type":"string","description":"Whether the unique click window is fixed or rolling.","enum":["FIXED","ROLLING"]}}}}},"paths":{"/Advertisers/{AccountSID}/Campaigns":{"get":{"operationId":"listPrograms","tags":["Programs"],"summary":"List all programs","description":"Returns a list of the programs for your account, sorted by program Id.","parameters":[{"name":"AccountSID","in":"path","required":true,"description":"The unique identifier for the account.","schema":{"type":"string"}},{"name":"Name","in":"query","description":"Filter by the name of the program.","schema":{"type":"string"}},{"name":"State","in":"query","description":"Filter by the state of the program.","schema":{"type":"string","enum":["ACTIVE","AWAITING_REVIEW","CANCELLED","CLOSED","DEACTIVATED","DELINQUENT","REJECTED","SETUP","SETUP_COMPLETE"]}}],"responses":{"200":{"description":"A list of program objects.","content":{"application/json":{"schema":{"type":"object","properties":{"Campaigns":{"type":"array","description":"The list of program objects.","items":{"$ref":"#/components/schemas/Program"}}}}}}}}}}}}
```

## Retrieve a program

> Retrieves the full details of an existing program using its unique ID.

```json
{"openapi":"3.1.0","info":{"title":"Brand Programs API","version":"v11"},"servers":[{"url":"https://api.impact.com"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"schemas":{"Program":{"type":"object","properties":{"Id":{"type":"integer","description":"The unique identifier for the program."},"Name":{"type":"string","description":"The display name of the program."},"State":{"type":"string","description":"The current state of the program.","enum":["ACTIVE","AWAITING_REVIEW","CANCELLED","CLOSED","DEACTIVATED","DELINQUENT","REJECTED","SETUP","SETUP_COMPLETE"]},"Categories":{"type":"object","description":"The program's category classifications.","properties":{"PrimaryCategory":{"type":"string","description":"The program's primary category."},"PrimarySubCategories":{"type":"array","description":"Subcategories under the primary category.","items":{"type":"string"}},"AdditionalCategory":{"type":"string","nullable":true,"description":"An additional category for the program, if any."},"AdditionalSubCategories":{"type":"array","description":"Subcategories under the additional category.","items":{"type":"string"}}}},"ShortDescription":{"type":"string","description":"A short description of the program."},"LongDescription":{"type":"string","description":"A long description of the program."},"ListInMarketplace":{"type":"boolean","description":"Whether the program is listed in the impact.com partner marketplace."},"DisplayServicingAgency":{"type":"boolean","description":"Whether the servicing agency is displayed publicly."},"Rating":{"type":"integer","description":"The program's rating."},"SearchKeywords":{"type":"string","description":"Keywords used to surface the program in marketplace search."},"ShippingRegions":{"type":"array","description":"Regions where the brand ships.","items":{"type":"string"}},"Resources":{"type":"object","description":"Links to brand-provided resources.","properties":{"CompanyHomepage":{"type":"string","format":"uri","description":"The company homepage URL."},"ExampleLandingPage":{"type":"string","format":"uri","description":"An example landing page URL."},"InformationPage":{"type":"string","format":"uri","description":"An information page URL."},"AdditionalRelatedLinks":{"type":"array","description":"Additional links related to the program.","items":{"type":"object","properties":{"LinkType":{"type":"string","description":"The type of link.","enum":["URL","PDF"]},"LinkDisplayName":{"type":"string","description":"Display name for the link."},"LinkUrl":{"type":"string","format":"uri","description":"The URL of the link."}}}}}},"CompanyContacts":{"type":"array","description":"Company contacts for the program.","items":{"type":"object","properties":{"FirstName":{"type":"string","description":"The contact's first name."},"LastName":{"type":"string","description":"The contact's last name."},"EmailAddress":{"type":"string","description":"The contact's email address."},"PhoneNumber":{"type":"string","description":"The contact's phone number."}}}},"GiftCardPayouts":{"type":"boolean","description":"Whether gift card payouts are enabled."},"TrademarkBidding":{"type":"boolean","description":"Whether partners are allowed to bid on the brand's trademark terms."},"ThirdPartyImpressionPixel":{"type":"string","description":"A third-party impression tracking pixel."},"MobileReadyAds":{"type":"boolean","description":"Whether the program supports mobile-ready ads."},"DisplayFutureAds":{"type":"boolean","description":"Whether to display ads that aren't yet active."},"PromoCodeTracking":{"type":"boolean","description":"Whether promo code tracking is enabled."},"TrackingDomain":{"type":"string","description":"The tracking domain used for this program."},"SiteDefinition":{"type":"string","description":"The site definition for the program."},"ImpressionTracking":{"type":"boolean","description":"Whether impression tracking is enabled."},"ViewThroughCrediting":{"type":"boolean","description":"Whether view-through crediting is enabled."},"IdentityMatching":{"type":"string","description":"The identity matching strategy.","enum":["NONE","ACCOUNT","IR_CONSORTIUM"]},"GatewayTrackingSettings":{"$ref":"#/components/schemas/GatewayTrackingSettings","description":"Settings for gateway tracking."},"DirectTrackingSettings":{"type":"object","description":"Settings for direct tracking.","properties":{"UnidentifiedName":{"type":"string","description":"Name used for unidentified traffic."},"SessionWindowLength":{"type":"string","description":"The session window length."}}},"Uri":{"type":"string","format":"uri-reference","description":"The unique reference to this program in the impact.com API."}}},"GatewayTrackingSettings":{"type":"object","properties":{"DefaultLandingPage":{"type":"string","format":"uri","description":"The default landing page URL."},"MediaPartnerTrackingTemplate":{"type":"string","description":"Tracking template applied to media partner links."},"CampaignTrackingTemplate":{"type":"string","description":"Tracking template applied to campaign links."},"SSLSupport":{"type":"boolean","description":"Whether SSL is supported for tracking links."},"DeepLinking":{"type":"boolean","description":"Whether deep linking is enabled."},"DeepLinkDomains":{"type":"string","description":"Comma-separated list of domains for deep linking."},"ThirdPartyGatewayUrl":{"type":"string","format":"uri","description":"A third-party gateway URL for tracking."},"ThirdPartyGatewayQueryStringParameters":{"type":"string","description":"Query string parameters for the third-party gateway."},"UniqueClickWindowLength":{"type":"string","description":"The length of the unique click window.","enum":["1m","5m","15m","30m","1h","6h","12h","24h"]},"UniqueClickWindowType":{"type":"string","description":"Whether the unique click window is fixed or rolling.","enum":["FIXED","ROLLING"]}}}}},"paths":{"/Advertisers/{AccountSID}/Campaigns/{CampaignId}":{"get":{"operationId":"getProgram","tags":["Programs"],"summary":"Retrieve a program","description":"Retrieves the full details of an existing program using its unique ID.","parameters":[{"name":"AccountSID","in":"path","required":true,"description":"The unique identifier for the account.","schema":{"type":"string"}},{"name":"CampaignId","in":"path","required":true,"description":"The unique identifier for the program (campaign).","schema":{"type":"integer"}}],"responses":{"200":{"description":"A single program object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Program"}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://integrations.impact.com/brand-api-reference/brand-api-reference-v11/reference/programs/programs.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.