Skip to main content
GET
/
v1
/
pvt
/
Objectives
/
active
Return all the active objectives for the client
curl --request GET \
  --url https://api.bonifiq.com.br/v1/pvt/Objectives/active \
  --header 'Authorization: Basic <encoded-value>'
{
  "Items": [
    {
      "Title": "<string>",
      "Description": "<string>",
      "AmountOfPoints": 123,
      "Active": true,
      "Details": "<unknown>",
      "Id": 123,
      "Type": 0
    }
  ],
  "TotalItemCount": 123,
  "PageSize": 123,
  "PageNumber": 123,
  "HasNextPage": true,
  "HasError": true,
  "ErrorMessages": [
    "<string>"
  ]
}

Authorizations

Authorization
string
header
required

Use API Basic Auth Keys

Query Parameters

CustomerId
string | null

ID of the logged in customer. Could be e-mail or document. Used to return if a customer already accomplished an objective. If null, all objectives will be returned.

PageNumber
integer<int32>

Pagenation number

PageSize
integer<int32>

Amount of items per page, Max size is 50 items per page.

Response

200 - application/json

Base List response model methods

Items
object[] | null

Collection with the found entities on the bonifiq DB.

TotalItemCount
integer<int32>

Total of rewards Configurations founds.

PageSize
integer<int32>

Pagination size

PageNumber
integer<int32>

Actual Page Number

HasNextPage
boolean

true if there is another page to be load.

HasError
boolean

If true the request had an error.

ErrorMessages
string[]

List with the error messages