API reference · Card Designs

List card designs

GET/v1/card-designs

List the card designs validated by Charitips. Set one as the momentSlug of a campaign: its cards, printed and posted on POSTAL campaigns, take that design.

Requires a Bearer access token.

Parameters

language#stringin query
Language of the card previews.
fren

Response

200 · CardDesign[]

momentSlug#stringalways returned
Value to set as the campaign momentSlug. Null for the Charitips card, the default.
accentColor#stringalways returned
Accent colour of the card, #rrggbb. Null for the Charitips card.
previewUrl#stringalways returned
Front of the card, without amount.

Errors

400A field is missing, has the wrong type, or is not part of the request schema.

Every request with a body or query is validated.

{
  "statusCode": 400,
  "message": [
    "amount must not be less than 1",
    "property foo should not exist"
  ],
  "error": "Bad Request"
}

401Unauthorized
Missing, expired or invalid access token.
```
{
  "statusCode": 401,
  "message": "Unauthorized"
}
```

403Account closed

{
  "message": "Account closed",
  "code": "ACCOUNT_CLOSED"
}

GET /v1/card-designs

1curl -X GET https://api.sandbox.charitips.com/v1/card-designs \2  -H "Authorization: Bearer $CHARITIPS_TOKEN"

Built from the spec and the API code

Request bodies are written for this docs and checked against the API's validation; ids in angle brackets are placeholders. Response values are placeholders built from the schema.