List Campaign.

get

https://api.test.bluestonepim.com/campaign/campaigns

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

status

string

enum

Campaign status.

Allowed:

keyword

string

Search keyword.

name

string

Campaign name.

title

string

Campaign title.

description

string

Campaign description.

customerProfileId

string

Customer profile id.

startDate

date-time

Campaign start date value in ISO 8601 date format.

expireDate

date-time

Campaign expire date value in ISO 8601 date format.

sortBy

string

enum

Defaults to name

sort by.

Allowed:

sort

string

enum

Defaults to asc

soring order of the campaign.

Allowed:

page

int32

0 to 1431655

Defaults to 0

Number of page, from 0 to 1431655.

pageSize

int32

1 to 1500

Defaults to 10

Size of page, from 1 to 1500.

Headers

context

string

Defaults to en

Specifies the context in which to operate. If omitted, the default context en is used.

In Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.

For more detailed information on how context relates to language settings in Bluestone PIM, refer to the Languages and Context documentation.

Note: The default context is identified by the ID "en". IDs for additional contexts begin with a lowercase "L", not with the digit "1", followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM.

context-fallback

boolean

Specifies whether to enable the fallback mechanism for the context. If omitted, the default value true will be used. When set to true, the system will provide a default translation or relevant information if the requested context's specific translation is missing.

For more detailed information on how context relates to language settings in Bluestone PIM, refer to the Languages and Context documentation.

Note: Setting the context-fallback parameter to false disables the fallback mechanism. In this configuration, if a translation or specific context information is not available, the system will not provide an alternative or default content. This ensures that only content that matches the exact context ID requested is returned, potentially leading to cases where no content is available if the specific translation is missing.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/full+json

200Campaign are listed.

400Bad request