Skip to content
Vimine for developers
EN

The association's published events, members-only included

GET
/v1/events
curl --request GET \
  --url 'https://api.vimine.network/v1/events?filter=upcoming' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
locale

The language to read the association’s copy in (it, en). Default: the member’s own language (member token), then Accept-Language, then the association’s. Each text is the association’s translation when it wrote one for a language it enabled, its Italian text otherwise: the answer’s locale says which was served for the title, locales which exist. An unsupported value is ignored

string
filter
string
Allowed values: upcoming past cancelled all
from
string format: date-time
to
string format: date-time
limit
integer
>= 1 <= 200

Responses

Section titled “Responses”

200

Section titled “200”

Events

Media typeapplication/json
object
items
Array<object>
object
id
string format: uuid
slug
string
locale

The language the title was served in. When it is not the one you asked for, the association has no translation: you got its Italian text, not a machine translation

string
locales

The languages in which this event has a title — the association’s own always, plus those it enabled and wrote

Array<string>
title
string
summary
string
nullable
description_md

Markdown; render it yourself

string
nullable
starts_at
string format: date-time
ends_at
string format: date-time
nullable
timezone
string
status
string
Allowed values: published completed cancelled
visibility
string
Allowed values: members_only public
location
object
name
string
nullable
address
string
nullable
lat
number
nullable
lng
number
nullable
cover_url
string
nullable
gallery
Array<object>
object
url
string
alt
string
nullable
order
integer
links
Array<object>
object
label
string
url
string
registration
object
opens_at
string format: date-time
nullable
closes_at
string format: date-time
nullable
capacity
integer
nullable
remaining
integer
nullable
cancellation_hours
integer
registration_types
Array<object>
object
uid
string format: uuid
cod
string
name
string
description
string
nullable
amount

0 = free

number
currency
string
quantity
integer
nullable
remaining

Places left (never who holds them)

integer
nullable
max_per_user
integer
requires_active_membership
boolean
open
boolean
reason
string
nullable
Allowed values: sold_out registration_not_open registration_closed
opens_at
string format: date-time
nullable
closes_at
string format: date-time
nullable
published_at
string format: date-time
nullable
cancelled_at
string format: date-time
nullable
cancel_reason
string
nullable
Example
{
  "items": [
    {
      "status": "published",
      "visibility": "members_only",
      "registration_types": [
        {
          "reason": "sold_out"
        }
      ]
    }
  ]
}

400

Section titled “400”

Invalid request

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
detail
string
code
required
string
request_id
string
errors
Array<object>
object
field
string
code
string
message
string
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}

401

Section titled “401”

Missing or invalid credentials

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
detail
string
code
required
string
request_id
string
errors
Array<object>
object
field
string
code
string
message
string
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}

403

Section titled “403”

Not allowed

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
detail
string
code
required
string
request_id
string
errors
Array<object>
object
field
string
code
string
message
string
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}

404

Section titled “404”

Not found

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
detail
string
code
required
string
request_id
string
errors
Array<object>
object
field
string
code
string
message
string
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}

429

Section titled “429”

Rate limited

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
detail
string
code
required
string
request_id
string
errors
Array<object>
object
field
string
code
string
message
string
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}

500

Section titled “500”

Internal error

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
detail
string
code
required
string
request_id
string
errors
Array<object>
object
field
string
code
string
message
string
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}