V2 List a customer's completed challenges

get

https://api.staging.antavo.com/v2/customers/{customer_id}/challenges

This endpoint returns a customer's challenge completion history. Results can be filtered with query parameters listed below.

Path Params

customer_id

string

required

Unique customer ID. This can be

The Antavo customer ID
An external ID (requires configuration): {external_field:external_id_value}

Query Params

created_at.lt

date-time

Filter by challenge creation date (less than)

created_at.lte

date-time

Filter by challenge creation date (less than or equal)

created_at.gt

date-time

Filter by challenge creation date (greater than)

created_at.gte

date-time

Filter by challenge creation date (greater than or equal)

last_completed_at.lt

date-time

Filter by last challenge completion date/time (less than)

last_completed_at.lte

date-time

Filter by last challenge completion date/time (less than or equal)

last_completed_at.gt

date-time

Filter by last challenge completion date/time (greater than)

last_completed_at.gte

date-time

Filter by last challenge completion date/time (greater than or equal)

string

Filter to a specific challenge by id.

offset

integer

Defaults to 0

Offsets the starting number of challenges to return. This is used in pagination in conjunction with the limit query.

limit

integer

1 to 100

Defaults to 20

Limits the number of challenges returned in one response. Other values are accessible by pagination made accessible via the offset.

Responses

Language

Credentials

Query

Loading…

Response

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

application/json

200List of the customer's challenge completions

400Bad request

404Not found