Documentation Index

Fetch the complete documentation index at: https://help.awin.com/llms.txt

Use this file to discover all available pages before exploring further.

Get Program Information

Prev Next
Get
/publishers/{publisherId}/programmes

This API is Available on Zapier

Automate your workflows with Zapier's easy to use workflow builder. Read more here or go directly our Zapier Integration Page

GET programs

Partners can check programmatically, with which programs they currently have an active, pending, suspended, rejected or not joined relationship. They can also check the whole program list, and filter by program region/country.

Who can use it?

Partners

Header parameters
Authorization
string

accessToken

Path parameters
publisherId
stringRequired

publisher id

Query parameters
accessToken
stringRequired

access token

countryCode
string

country code has to be ISO Alpha-2, i.e. GB, DE, FR, ...

includeHidden
boolean

Only works when no relationship is specified

relationship
string

relationship

Valid values[ "joined", "pending", "suspended", "rejected", "notjoined" ]
Responses
200

OK

Array of object
object
clickThroughUrl
string
currencyCode
string
description
string
displayUrl
string
id
integer (int64)
linkStatus
string
logoUrl
string
name
string
primaryRegion
object (PrimaryRegion)
countryCode
string
name
string
primarySector
string
status
string
validDomains
Array of object (Domain)
object
domain
string

Which data fields do we provide?

Field name

Description

Description

Advertiser program description

DisplayUrl

Program display URL

LogoUrl

URL to the logo of the program

ClickThroughUrl

Program click-through URL

Id

Advertiser program ID

Name

Program name

CurrencyCode

ISO code of the currency of the program

PrimaryRegion

Program primary region

Status

Program status. Can be active or hidden

ValidDomains

List of the program valid domains 

LinkStatus

Current status of links, which can be either "online" or "offline" - this applies only to programs that are funded through prepayment funds