Challenges

Manage sales challenges, track progress, and activate participation for specific locations.

Get location challenges

get

Retrieve a list of all challenges linked to a specific location.

Required Permission: challenges.list

Authorizations

ApiKeyAuth

X-API-KEYstringRequired

Standard API Key authentication.

Path parameters

fyre_idstringRequired

The unique Location ID.

Example: FR0100000000

Query parameters

Responses

200

Success

application/json

idstringRead-onlyRequiredExample: 00kfmzzPqP9YlLT05C40

fyre_idstringRead-onlyRequiredExample: FR0100000000

titlestringRequiredExample: Summer Burger Sales Sprint

brand_namestringRequiredExample: Burger King

brand_idstringRequiredExample: BR-5544

goal_typestring · enumRequired

The metric used to determine challenge completion.

• amount - Revenue target.
• quantity - Unit sales target.
• uplift - Growth percentage vs previous year.

Possible values:

descriptionstringOptionalExample: Sell 500 units of the new spicy burger to win.

contact_emailstring · emailOptionalExample: [email protected]

logo_urlstring · uriOptional

banner_urlstring · uriOptional

terms_and_conditions_urlstring · uriOptional

terms_and_conditionsstring[]Optional

location_challenge_statusstring · enumRequired

Current lifecycle status of the challenge.

Possible values:

start_datestring · date-timeRequiredExample: 2024-07-24T14:39:39.447Z

end_datestring · date-timeRequiredExample: 2024-08-24T14:39:39.447Z

accepted_atstring · date-timeOptional

completed_atstring · date-timeOptional

created_atstring · date-timeRequired

updated_atstring · date-timeOptional

400

Bad Request

application/json

401

Unauthorized

application/json

get

/locations/{fyre_id}/challenges

cURLJavaScript (Fetch)JavaScript (Axios)

curl --request GET \
  --url 'https://api.fyre.app/api/v1/locations/FR0100000000/challenges?filter[status][]=published' \
  --header 'X-API-KEY: YOUR_TOKEN'

[
  {
    "id": "00kfmzzPqP9YlLT05C40",
    "fyre_id": "FR0100000000",
    "title": "Summer Burger Sales Sprint",
    "brand_name": "Burger King",
    "brand_id": "BR-5544",
    "goal_type": "amount",
    "description": "Sell 500 units of the new spicy burger to win.",
    "contact_email": "[email protected]",
    "logo_url": "https://example.com",
    "banner_url": "https://example.com",
    "terms_and_conditions_url": "https://example.com",
    "terms_and_conditions": [
      "text"
    ],
    "location_challenge_status": "published",
    "start_date": "2024-07-24T14:39:39.447Z",
    "end_date": "2024-08-24T14:39:39.447Z",
    "goals": {
      "quantity": 500,
      "revenue": 15000.5
    },
    "products": [
      {
        "referential_ref": "PRD-998877",
        "name": "Spicy Chicken Burger",
        "image_url": "https://cdn.fyre.app/products/burger.jpg"
      }
    ],
    "sales": {
      "PRD-001": {
        "quantity": 50,
        "revenue": 500
      }
    },
    "accepted_at": "2026-03-30T13:51:38.933Z",
    "completed_at": "2026-03-30T13:51:38.933Z",
    "created_at": "2026-03-30T13:51:38.933Z",
    "updated_at": "2026-03-30T13:51:38.933Z"
  }
]

Get challenge details

get

Retrieve full details of a specific challenge, including goals, products, and terms.

Required Permission: challenges.read

Authorizations

ApiKeyAuth

X-API-KEYstringRequired

Standard API Key authentication.

Path parameters

fyre_idstringRequired

The unique Location ID.

Example: FR0100000000

challenge_idstringRequired

The unique Challenge ID.

Example: 00kfmzzPqP9YlLT05C40

Responses

200

Success

application/json

idstringRead-onlyRequiredExample: 00kfmzzPqP9YlLT05C40

fyre_idstringRead-onlyRequiredExample: FR0100000000

titlestringRequiredExample: Summer Burger Sales Sprint

brand_namestringRequiredExample: Burger King

brand_idstringRequiredExample: BR-5544

goal_typestring · enumRequired

The metric used to determine challenge completion.

• amount - Revenue target.
• quantity - Unit sales target.
• uplift - Growth percentage vs previous year.

Possible values:

descriptionstringOptionalExample: Sell 500 units of the new spicy burger to win.

contact_emailstring · emailOptionalExample: [email protected]

logo_urlstring · uriOptional

banner_urlstring · uriOptional

terms_and_conditions_urlstring · uriOptional

terms_and_conditionsstring[]Optional

location_challenge_statusstring · enumRequired

Current lifecycle status of the challenge.

Possible values:

start_datestring · date-timeRequiredExample: 2024-07-24T14:39:39.447Z

end_datestring · date-timeRequiredExample: 2024-08-24T14:39:39.447Z

accepted_atstring · date-timeOptional

completed_atstring · date-timeOptional

created_atstring · date-timeRequired

updated_atstring · date-timeOptional

401

Unauthorized

application/json

404

Not Found

application/json

get

/locations/{fyre_id}/challenges/{challenge_id}

cURLJavaScript (Fetch)JavaScript (Axios)

curl --request GET \
  --url https://api.fyre.app/api/v1/locations/FR0100000000/challenges/00kfmzzPqP9YlLT05C40 \
  --header 'X-API-KEY: YOUR_TOKEN'

{
  "id": "00kfmzzPqP9YlLT05C40",
  "fyre_id": "FR0100000000",
  "title": "Summer Burger Sales Sprint",
  "brand_name": "Burger King",
  "brand_id": "BR-5544",
  "goal_type": "amount",
  "description": "Sell 500 units of the new spicy burger to win.",
  "contact_email": "[email protected]",
  "logo_url": "https://example.com",
  "banner_url": "https://example.com",
  "terms_and_conditions_url": "https://example.com",
  "terms_and_conditions": [
    "text"
  ],
  "location_challenge_status": "published",
  "start_date": "2024-07-24T14:39:39.447Z",
  "end_date": "2024-08-24T14:39:39.447Z",
  "goals": {
    "quantity": 500,
    "revenue": 15000.5
  },
  "products": [
    {
      "referential_ref": "PRD-998877",
      "name": "Spicy Chicken Burger",
      "image_url": "https://cdn.fyre.app/products/burger.jpg"
    }
  ],
  "sales": {
    "PRD-001": {
      "quantity": 50,
      "revenue": 500
    }
  },
  "accepted_at": "2026-03-30T13:51:38.933Z",
  "completed_at": "2026-03-30T13:51:38.933Z",
  "created_at": "2026-03-30T13:51:38.933Z",
  "updated_at": "2026-03-30T13:51:38.933Z"
}

Activate challenge

post

Accept a challenge to begin tracking sales for that location.

Required Permission: challenges.accept

Authorizations

ApiKeyAuth

X-API-KEYstringRequired

Standard API Key authentication.

Path parameters

fyre_idstringRequired

The unique Location ID.

Example: FR0100000000

challenge_idstringRequired

The unique Challenge ID.

Example: 00kfmzzPqP9YlLT05C40

Body

application/json

fyre_idstringRequired

Must match the location in the URL.

challenge_idstringRequired

Must match the challenge in the URL.

Responses

200

Challenge Accepted

application/json

idstringRead-onlyRequiredExample: 00kfmzzPqP9YlLT05C40

fyre_idstringRead-onlyRequiredExample: FR0100000000

titlestringRequiredExample: Summer Burger Sales Sprint

brand_namestringRequiredExample: Burger King

brand_idstringRequiredExample: BR-5544

goal_typestring · enumRequired

The metric used to determine challenge completion.

• amount - Revenue target.
• quantity - Unit sales target.
• uplift - Growth percentage vs previous year.

Possible values:

descriptionstringOptionalExample: Sell 500 units of the new spicy burger to win.

contact_emailstring · emailOptionalExample: [email protected]

logo_urlstring · uriOptional

banner_urlstring · uriOptional

terms_and_conditions_urlstring · uriOptional

terms_and_conditionsstring[]Optional

location_challenge_statusstring · enumRequired

Current lifecycle status of the challenge.

Possible values:

start_datestring · date-timeRequiredExample: 2024-07-24T14:39:39.447Z

end_datestring · date-timeRequiredExample: 2024-08-24T14:39:39.447Z

accepted_atstring · date-timeOptional

completed_atstring · date-timeOptional

created_atstring · date-timeRequired

updated_atstring · date-timeOptional

401

Unauthorized

application/json

404

Not Found

application/json

post

/locations/{fyre_id}/challenges/{challenge_id}/activate

cURLJavaScript (Fetch)JavaScript (Axios)

curl --request POST \
  --url https://api.fyre.app/api/v1/locations/FR0100000000/challenges/00kfmzzPqP9YlLT05C40/activate \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: YOUR_TOKEN' \
  --data '{
	"fyre_id": "FR0100000000",
	"challenge_id": "00kfmzzPqP9YlLT05C40"
}'

{
  "id": "00kfmzzPqP9YlLT05C40",
  "fyre_id": "FR0100000000",
  "title": "Summer Burger Sales Sprint",
  "brand_name": "Burger King",
  "brand_id": "BR-5544",
  "goal_type": "amount",
  "description": "Sell 500 units of the new spicy burger to win.",
  "contact_email": "[email protected]",
  "logo_url": "https://example.com",
  "banner_url": "https://example.com",
  "terms_and_conditions_url": "https://example.com",
  "terms_and_conditions": [
    "text"
  ],
  "location_challenge_status": "published",
  "start_date": "2024-07-24T14:39:39.447Z",
  "end_date": "2024-08-24T14:39:39.447Z",
  "goals": {
    "quantity": 500,
    "revenue": 15000.5
  },
  "products": [
    {
      "referential_ref": "PRD-998877",
      "name": "Spicy Chicken Burger",
      "image_url": "https://cdn.fyre.app/products/burger.jpg"
    }
  ],
  "sales": {
    "PRD-001": {
      "quantity": 50,
      "revenue": 500
    }
  },
  "accepted_at": "2026-03-30T13:51:38.933Z",
  "completed_at": "2026-03-30T13:51:38.933Z",
  "created_at": "2026-03-30T13:51:38.933Z",
  "updated_at": "2026-03-30T13:51:38.933Z"
}