API docs by Redocly

Prestatie API (1.0.0)

Download OpenAPI specification:Download

E-mail: support@prestatieapi.com

Welcome to the Prestatie API documentation.

Achievements

All actions for the achievements

List achievements

List all achievements in your groups

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Create achievement

Authorizations:
bearerAuth
Request Body schema: application/json
name
string [ 3 .. 50 ] characters

The name of the achievement

description
string or null <= 255 characters

A description about the achievement

is_active
boolean

When this option is false the achievement cannot be achieved.

category
string or null <uuid>

The uuid of the category

type
string (Type)
Enum: "DIRECT" "PROGRESSION"

Direct achievements can be achieved without any progression.

image
string or null <url> <= 255 characters

Can be an external url, or upload an image in the portal

achievable_until
string or null <date-time>

A date until these achievement can be achieved.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "is_active": true,
  • "category": "86d23d13-9dbb-46f3-82d0-25253c7750c3",
  • "type": "DIRECT",
  • "image": "string",
  • "achievable_until": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "achievable_until": "2023-10-10",
  • "achieved_percentage": 0,
  • "category": null,
  • "created_at": "2024-03-20",
  • "description": null,
  • "image": "http://test.nl/image.png",
  • "is_active": true,
  • "name": "My first achievement",
  • "tags": [ ],
  • "type": "DIRECT",
  • "uuid": "e2d3970d-9867-4c30-8633-026a8c2e0622"
}

Update achievement

Authorizations:
bearerAuth
path Parameters
uuid
required
string

The uuid of the achievement

Request Body schema: application/json
name
string [ 3 .. 50 ] characters

The name of the achievement

description
string or null <= 255 characters

A description about the achievement

is_active
boolean

When this option is false the achievement cannot be achieved.

category
string or null <uuid>

The uuid of the category

type
string (Type)
Enum: "DIRECT" "PROGRESSION"

Direct achievements can be achieved without any progression.

image
string or null <url> <= 255 characters

Can be an external url, or upload an image in the portal

achievable_until
string or null <date-time>

A date until these achievement can be achieved.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "is_active": true,
  • "category": "86d23d13-9dbb-46f3-82d0-25253c7750c3",
  • "type": "DIRECT",
  • "image": "string",
  • "achievable_until": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "uuid": "b6974fa3-356c-428e-9da9-ec5848a284ca",
  • "name": "Your first achievement",
  • "description": "Achieve your first achievement!",
  • "type": "DIRECT",
  • "achievable_until": "2024-03-22T00:00:00.000000Z",
  • "achieved_percentage": 80,
  • "category": null,
  • "image": null,
  • "is_active": 1,
  • "tags": [
    ],
  • "created_at": "2024-03-22T16:14:38.000000Z",
  • "updated_at": "2024-03-24T08:34:38.000000Z"
}

Delete achievement

Authorizations:
bearerAuth
path Parameters
uuid
required
string

The uuid of the achievement

Responses

Get single achievement

Get a single achievement from your group

Authorizations:
bearerAuth
path Parameters
uuid
required
string

The uuid of the achievement

Responses

Response samples

Content type
application/json
{
  • "uuid": "b6974fa3-356c-428e-9da9-ec5848a284ca",
  • "name": "Your first achievement",
  • "description": "Achieve your first achievement!",
  • "type": "DIRECT",
  • "achievable_until": "2024-03-22T00:00:00.000000Z",
  • "achieved_percentage": 80,
  • "category": null,
  • "image": null,
  • "is_active": 1,
  • "tags": [
    ],
  • "created_at": "2024-03-22T16:14:38.000000Z",
  • "updated_at": "2024-03-24T08:34:38.000000Z"
}

Categories

Group your achievements with categories

List all categories

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Create an achievement category

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "uuid": "0accc1b2-6797-4966-b99d-f3067a9591d5",
  • "name": "General",
  • "created_at": "2024-03-25T19:47:36.000000Z",
  • "updated_at": "2024-03-25T19:47:36.000000Z"
}

Delete an achievement category

Authorizations:
bearerAuth

Responses

Update an achievement category

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "uuid": "0accc1b2-6797-4966-b99d-f3067a9591d5",
  • "name": "General",
  • "created_at": "2024-03-25T19:47:36.000000Z",
  • "updated_at": "2024-03-25T19:47:36.000000Z"
}

Get a single achievement category

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "uuid": "0accc1b2-6797-4966-b99d-f3067a9591d5",
  • "name": "General",
  • "created_at": "2024-03-25T19:47:36.000000Z",
  • "updated_at": "2024-03-25T19:47:36.000000Z"
}

Tags

Tag your achievements

List all tags

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • "Tag-1",
  • "Tag-2"
]

Add tag to achievement

Authorizations:
bearerAuth
Request Body schema: application/json
achievement
string <uuid>
tag
string [ 2 .. 25 ] characters

Responses

Request samples

Content type
application/json
{
  • "achievement": "6cad72bd-5768-4b2f-bed5-1727d10619ca",
  • "tag": "string"
}

Response samples

Content type
application/json
{
  • "errors": {
    },
  • "message": "The external id has already been taken. (and 1 more error)"
}

Remove tag from achievement

Authorizations:
bearerAuth
Request Body schema: application/json
achievement
string <uuid>
tag
string [ 2 .. 25 ] characters

Responses

Request samples

Content type
application/json
{
  • "achievement": "6cad72bd-5768-4b2f-bed5-1727d10619ca",
  • "tag": "string"
}

Response samples

Content type
application/json
{
  • "errors": {
    },
  • "message": "The external id has already been taken. (and 1 more error)"
}

Members

All members in your group who can interact with achievements

List members

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Create

Authorizations:
bearerAuth
Request Body schema: application/json
external_id
string <uuid>
external_name
string [ 3 .. 50 ] characters

Responses

Request samples

Content type
application/json
{
  • "external_id": "95c35493-41aa-44f8-9154-5a25cbbc1865",
  • "external_name": "string"
}

Response samples

Content type
application/json
{
  • "errors": {
    },
  • "message": "The external id has already been taken. (and 1 more error)"
}

Create bulk

Create up to 100 members in bulk

Authorizations:
bearerAuth
Request Body schema: application/json
object
object

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Update a member

Authorizations:
bearerAuth
path Parameters
uuid
required
string

The uuid of the member

Request Body schema: application/json
name
string [ 3 .. 50 ] characters

The name of the achievement

description
string or null <= 255 characters

A description about the achievement

is_active
boolean

When this option is false the achievement cannot be achieved.

category
string or null <uuid>

The uuid of the category

type
string (Type)
Enum: "DIRECT" "PROGRESSION"

Direct achievements can be achieved without any progression.

image
string or null <url> <= 255 characters

Can be an external url, or upload an image in the portal

achievable_until
string or null <date-time>

A date until these achievement can be achieved.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "is_active": true,
  • "category": "86d23d13-9dbb-46f3-82d0-25253c7750c3",
  • "type": "DIRECT",
  • "image": "string",
  • "achievable_until": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "uuid": "0accc1b2-6797-4966-b99d-f3067a9591d5",
  • "external_name": "Peter",
  • "external_id": "0ee98a32-b312-4b25-9da7-36b26ed734ec",
  • "created_at": "2024-03-25T19:47:36.000000Z",
  • "updated_at": "2024-03-25T19:47:36.000000Z"
}

Delete a member

Authorizations:
bearerAuth
path Parameters
uuid
required
string

The uuid of the member

Responses

Find a single member

Authorizations:
bearerAuth
path Parameters
uuid
required
string

The uuid of the member

Responses

Response samples

Content type
application/json
{
  • "achievements": [
    ],
  • "external_id": "fdfffd76-4900-454b-8fae-fd0948601c5e",
  • "external_name": "Test1234",
  • "uuid": "f346b964-37cb-415a-b79e-032daf040da0"
}

Let a member achieve the given achievement

Authorizations:
bearerAuth

Responses

Remove an achieved achievement from the member

Authorizations:
bearerAuth

Responses

Decrement a progression achievement for the member

Authorizations:
bearerAuth

Responses

Increment a progression achievement

Authorizations:
bearerAuth

Responses

Event History

List all events

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

List all events from cursor

Authorizations:
bearerAuth
path Parameters
searchDirection
required
string

Show items before or after the cursor. (valid input: after, before)

cursor
required
integer

The cursor

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]