# List incentive schemes

Returns a list of Incentive Schemes that the authenticated User is eligble for.

Endpoint: GET /incentive_schemes
Version: 2.0
Security: oauth2

## Header parameters:

  - `EvEnergy-User` (string)
    This endpoints requires a user ID to be specified via this header when using Client Credentials authentication.
    Example: "user01HN2NJ9NMRZBXT1H6FT9N7735"

## Response 200 fields (application/json):

  - `id` (string)
    Prefix: "incs"

  - `name` (string)
    Name to be displayed to the User.

  - `description` (string)
    Describes the rules of how the User earns this Incentive.

  - `visible` (boolean)
    Should this Incentive Scheme be visible to the User in the App.

  - `available` (boolean)
    Is this Incentive available for the User to earn.
Some Incentive Schemes can only be earned a limitted number of times per User or Device.
E.g. A Sign Up Incentive that can only be earned once per Device.
This will also be False if it is outside the active period of the Incentive Scheme.

## Response 400 fields (application/problem+json):

  - `type` (string)
    Example: "https://api.ev.energy/v2/problems/example-problem/"

  - `status` (number)
    Example: 400

  - `title` (string, required)
    Example: "Short description"

  - `detail` (string, required)
    Example: "Long, more specific description."

  - `instance` (string)
    Example: "https://api.ev.energy/v2/users/user01HN2P75GBNFRJPCZJXEFVXH5E"

  - `notification` (object)
    Something that the user should be informed about.

  - `notification.id` (string, required)
    Unique identifier for the Notification
    Example: "notf67O36PLTFDB57M0E5L33JZLGM0"

  - `notification.url` (string, required)
    Example: "https://api.ev.energy/notifications/notf67O36PLTFDB57M0E5L33JZLGM0"

  - `notification.message_id` (string, required)
    Internal identifier for this notification type. E.g. 'ERR0023'

  - `notification.category` (any, required)
    Category of this notification type
    Enum: "ACTIONABLE", "SERVICE", "RETRY", "MARKETING", "INTERNAL"

  - `notification.event_time` (string, required)
    The timestamp of the event described by this notification

  - `notification.short_text_title` (string, required)
    Short title for the notification

  - `notification.short_text_body` (string, required)
    Short description of the event being notified

  - `notification.detail_page_title` (string)
    Title of a help page giving more information about this notification

  - `notification.detail_page_body` (string)
    Text of a help page giving more information about this notification

  - `notification.external_link` (string,null)
    URL of a web page giving further information about this notification

  - `notification.external_button_label` (string)
    Text to be displayed on a button leading to the external_link location

  - `notification.read_at` (string)
    When the user examined the contents of this notification

  - `notification.resolved_at` (string)
    When the problem associated with this notification was resolved

## Response 401 fields (application/problem+json):

  - `status` (number)
    Example: 401

  - `title` (string, required)
    Example: "Unauthorized"

  - `detail` (string, required)
    Example: "Authentication credentials were not provided."

## Response 403 fields (application/problem+json):

  - `status` (number)
    Example: 403

  - `title` (string, required)
    Example: "Forbidden"

  - `detail` (string, required)
    Example: "You do not have permission to perform this action."

## Response 429 fields (application/problem+json):

  - `type` (string)
    Example: "https://api.ev.energy/v2/problems/example-problem/"

  - `status` (number)
    Example: 400

  - `title` (string, required)
    Example: "Short description"

  - `detail` (string, required)
    Example: "Long, more specific description."

  - `instance` (string)
    Example: "https://api.ev.energy/v2/users/user01HN2P75GBNFRJPCZJXEFVXH5E"

  - `notification` (object)
    Something that the user should be informed about.

  - `notification.id` (string, required)
    Unique identifier for the Notification
    Example: "notf67O36PLTFDB57M0E5L33JZLGM0"

  - `notification.url` (string, required)
    Example: "https://api.ev.energy/notifications/notf67O36PLTFDB57M0E5L33JZLGM0"

  - `notification.message_id` (string, required)
    Internal identifier for this notification type. E.g. 'ERR0023'

  - `notification.category` (any, required)
    Category of this notification type
    Enum: "ACTIONABLE", "SERVICE", "RETRY", "MARKETING", "INTERNAL"

  - `notification.event_time` (string, required)
    The timestamp of the event described by this notification

  - `notification.short_text_title` (string, required)
    Short title for the notification

  - `notification.short_text_body` (string, required)
    Short description of the event being notified

  - `notification.detail_page_title` (string)
    Title of a help page giving more information about this notification

  - `notification.detail_page_body` (string)
    Text of a help page giving more information about this notification

  - `notification.external_link` (string,null)
    URL of a web page giving further information about this notification

  - `notification.external_button_label` (string)
    Text to be displayed on a button leading to the external_link location

  - `notification.read_at` (string)
    When the user examined the contents of this notification

  - `notification.resolved_at` (string)
    When the problem associated with this notification was resolved