Get Campaigns

get

/campaigns

Request

Query Parameters
  • Comma-delimited string of child resource names that you want to expand so that the contents return with the parent in the same GET request.
  • Comma-delimited string of field names that you wanted returned in a GET request.
  • Positive integer value that specifies the maximum number of items returned by the server.
  • Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection.
  • Comma-separated string of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
  • Filter (a 'where'clause) to restrict the items returned in the collection. By default, no filtering is applied.
  • Boolean value that specifies whether to calculate the totalResults property. By default, this value is set to false indicating that totalResults is not calculated.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

Default Response.
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : campaigns
Type: object
Show Source
Nested Schema : attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate11
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate12
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate13
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate14
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate15
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate16
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate17
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate18
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate19
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate2
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate20
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate3
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate4
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate5
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate6
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate7
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate8
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate9
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : documents
Type: object
Show Source
Nested Schema : effectiveDate
The start date of the campaign.
Match All
Show Source
Nested Schema : expirationDate
The end date of the campaign.
Match All
Show Source
Nested Schema : insertDate
Read Only: true
insert date
Match All
Show Source
Nested Schema : involvedParties
Type: object
Show Source
Nested Schema : lines
Type: object
Show Source
Nested Schema : refnums
Type: object
Show Source
Nested Schema : remarks
Type: object
Show Source
Nested Schema : remDuration
The duration in which a reminder will be sent to the supplier.
Match All
Show Source
Nested Schema : statuses
Type: object
Show Source
Nested Schema : updateDate
Read Only: true
update date
Match All
Show Source
Nested Schema : dateTimeType
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : campaigns.documents
Type: object
Show Source
Nested Schema : effectiveDate
represents effective date for a document
Match All
Show Source
Nested Schema : expirationDate
Represents expiration date for a document.
Match All
Show Source
Nested Schema : generatedAt
If preparation, date/time content was last generated
Match All
Show Source
Nested Schema : uploadedAt
If attachment, date/time content was last updated
Match All
Show Source
Nested Schema : dateType
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : campaigns.involvedParties
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : campaigns.lines
Type: object
Show Source
Nested Schema : attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate11
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate12
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate13
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate14
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate15
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate16
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate17
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate18
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate19
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate2
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate20
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate3
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate4
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate5
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate6
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate7
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate8
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate9
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : involvedParties
Type: object
Show Source
Nested Schema : notes
Type: object
Show Source
Nested Schema : originEffectiveDate
The date on which the country of origin is effective.
Match All
Show Source
Nested Schema : originExpirationDate
The date on which the country of origin expires.
Match All
Show Source
Nested Schema : qfEffectiveDate
The date on which the qualification for a trade program is effective.
Match All
Show Source
Nested Schema : qfExpirationDate
The date on which the qualification for a trade program expires.
Match All
Show Source
Nested Schema : refnums
Type: object
Show Source
Nested Schema : remarks
Type: object
Show Source
Nested Schema : reqdocs
Type: object
Show Source
Nested Schema : statuses
Type: object
Show Source
Nested Schema : values
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : campaigns.lines.involvedParties
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : campaigns.lines.notes
Type: object
Show Source
Nested Schema : noteDate
This fields holds the date on which note was added on campaign line.
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : campaigns.lines.refnums
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : campaigns.lines.remarks
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : campaigns.lines.reqdocs
Type: object
Show Source
Nested Schema : docs
Type: object
Show Source
Nested Schema : reviewers
Type: object
Show Source
Nested Schema : statuses
Type: object
Show Source
Nested Schema : subscribers
Type: object
Show Source
Nested Schema : texts
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : campaigns.lines.reqdocs.docs
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : campaigns.lines.reqdocs.reviewers
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : campaigns.lines.reqdocs.statuses
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : campaigns.lines.reqdocs.subscribers
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : campaigns.lines.reqdocs.texts
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : campaigns.lines.statuses
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : campaigns.lines.values
Type: object
Show Source
Nested Schema : currencyValue
No description.
Match All
Show Source
Nested Schema : exchangeRateDate
No description.
Match All
Show Source
Nested Schema : currencyType
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : campaigns.refnums
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : campaigns.remarks
Type: object
Show Source
Nested Schema : amountType
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : campaigns.statuses
Type: object
Show Source
Back to Top