INinfobip
platform
numbers
number-registration
campaigns

Get Campaigns

Gets a page of campaigns, using query parameters to filter results.

get/number-registration/1/campaigns

Request

  • Base URL
    https://api.infobip.com (the document declares no server; this is the origin it was published from)
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://api.infobip.com/auth/1/oauth2/token
    • or API key in header Authorization
    • or API key in header Authorization
    • or HTTP basic

Query parameters

idstring[]

Filters campaigns to those that match the supplied ID(s).

brandIdstring[]

Filters campaigns to those that match the supplied brand ID(s).

typestring[]

Filters campaigns to those that match the supplied campaign type(s).

nameLikestring

Filters campaigns to those whose names contain the supplied name.

referenceIdstring[]

Filters campaigns to those that match the supplied referenceId(s).

applicationIdstring

Filters campaigns to those whose application ID contains the supplied value.

entityIdstring

Filters campaigns to those whose entity ID contains the supplied value.

stagestring[]

Filters campaigns to those that match the campaign stage(s).

numberstring[]

Filters campaigns to those that match the number(s).

pageinteger

Results page you want to retrieve (0..N). The default value is 0.

sizeinteger

Number of records per page (0..2000). The default value is 20. The maximum value is 2000.

sortstring[]

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Sortable Properties: 'id', 'name', 'type', 'createdDate', 'lastModifiedDate'.

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.