GET
/
api
/
v1
/
events
{
  "hydra:member": [
    {
      "@context": "<string>",
      "@id": "<string>",
      "@type": "<string>",
      "id": 123,
      "uuid": "<string>",
      "name": "<string>",
      "location": "<string>",
      "description": "<string>",
      "logo": "<string>",
      "owner": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "id": 123,
        "firstName": "<string>",
        "lastName": "<string>",
        "fullName": "<string>",
        "timezone": "<string>",
        "logo": "<string>"
      },
      "type": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "id": 123,
        "name": "<string>",
        "color": "<string>",
        "icon": "<string>",
        "createIsGrantedRole": "ROLE_USER"
      },
      "unit": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "id": 123,
        "name": "<string>"
      },
      "dateCreated": "2023-11-07T05:31:56Z",
      "tags": "<any>",
      "goal": "<string>",
      "target": "<string>",
      "activities": "<string>",
      "advertising": "<string>",
      "budget": "<string>",
      "partners": "<string>",
      "numberOfParticipants": 123,
      "isGeneralMeeting": true,
      "isGeneralMeetingEx": true,
      "isGeneralMeetingElection": true,
      "isTraining": true,
      "eventMedia": [
        {
          "@context": "<string>",
          "@id": "<string>",
          "@type": "<string>",
          "id": 123,
          "media": {
            "@context": "<string>",
            "@id": "<string>",
            "@type": "<string>",
            "id": 123,
            "size": 123,
            "entityId": 123,
            "contentUrl": "<string>",
            "type": "<string>"
          }
        }
      ],
      "isAttendable": true,
      "logoFromAlbum": "<string>",
      "dateTimeBegin": "2023-11-07T05:31:56Z",
      "dateTimeEnd": "2023-11-07T05:31:56Z",
      "isAnnualReport": true,
      "product": {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "uuid": "<string>",
        "id": 123,
        "name": "<string>",
        "nameEn": "<string>",
        "productPrices": [
          {
            "@context": "<string>",
            "@id": "<string>",
            "@type": "<string>",
            "id": 123,
            "currency": "<string>",
            "price": 123,
            "name": "<string>",
            "isSubscription": true,
            "isRestricted": "<string>",
            "fullDescription": "<string>",
            "displayNameOnPaymentPage": true,
            "isLifetime": true
          }
        ],
        "description": "<string>",
        "descriptionEn": "<string>",
        "logo": "<string>",
        "isFee": true,
        "isDonation": true,
        "settings": {
          "tenantLogo": true,
          "showTitle": true,
          "colorSelection": null,
          "colorButton": null,
          "disableSubscribe": false,
          "commentSection": true,
          "newestAndTopDonationSection": true,
          "requireFullAddress": false,
          "disableRegister": false,
          "lightThemeOnly": false,
          "isThankYouSingular": false
        },
        "descriptionInternal": "<string>",
        "event": {},
        "productOptions": [
          {
            "@context": "<string>",
            "@id": "<string>",
            "@type": "<string>",
            "id": 123,
            "name": "<string>",
            "isArchived": true
          }
        ],
        "type": "<string>",
        "displayOnProfile": true,
        "productPriceVariations": [
          "https://example.com/"
        ],
        "metaGraphImage": "<string>",
        "heroVideoUrl": "<string>",
        "thankYouMessage": "<string>",
        "descriptionDe": "<string>"
      },
      "meet": "<string>",
      "isOnline": true,
      "settings": {
        "tenantLogo": true,
        "showTitle": true,
        "colorSelection": null,
        "colorButton": null,
        "disableSubscribe": false,
        "disableRegister": true,
        "lightThemeOnly": false,
        "isThankYouSingular": false,
        "fieldName": true,
        "fieldEmail": true,
        "fieldPhone": false,
        "fieldOrganisation": false,
        "fieldRole": false,
        "fieldTown": false,
        "fieldLinkedin": false,
        "fieldX": false,
        "fieldInstagram": false
      },
      "hasVoting": true,
      "sdg": [
        "<string>"
      ],
      "isPublic": true,
      "hasEventTicketing": true,
      "timezone": "<string>",
      "isPast": true,
      "status": "draft",
      "newsletterEnabled": true,
      "placesApiId": "<string>",
      "slugGo": "<string>",
      "placeLatitude": 123,
      "placeLongitude": 123
    }
  ],
  "hydra:totalItems": 1,
  "hydra:view": {
    "@id": "string",
    "type": "string",
    "hydra:first": "string",
    "hydra:last": "string",
    "hydra:previous": "string",
    "hydra:next": "string"
  },
  "hydra:search": {
    "@type": "<string>",
    "hydra:template": "<string>",
    "hydra:variableRepresentation": "<string>",
    "hydra:mapping": [
      {
        "@type": "<string>",
        "variable": "<string>",
        "property": "<string>",
        "required": true
      }
    ]
  }
}

Query Parameters

page
integer
default:1

The collection page number

pagination
boolean

Enable or disable pagination

dateTimeBegin[before]
string
dateTimeBegin[strictly_before]
string
dateTimeBegin[after]
string
dateTimeBegin[strictly_after]
string
dateTimeEnd[before]
string
dateTimeEnd[strictly_before]
string
dateTimeEnd[after]
string
dateTimeEnd[strictly_after]
string
name
string
type
string
type[]
string[]
unit
string
unit[]
string[]
owner
string
owner[]
string[]
isAnnualReport
boolean
isAnnualReport[]
boolean[]
sdg
string
product
string
product[]
string[]
tenant
string
tenant[]
string[]
order[dateTimeBegin]
enum<string>
default:asc
Available options:
asc,
desc
order[name]
enum<string>
default:asc
Available options:
asc,
desc
order[type.name]
enum<string>
default:asc
Available options:
asc,
desc
order[unit.name]
enum<string>
default:asc
Available options:
asc,
desc
order[location]
enum<string>
default:asc
Available options:
asc,
desc
exists[unit]
boolean

Response

200
application/ld+json

Event collection

The response is of type object.