v1

latestOpenAPI 3.0.02026-07-2688129326.6 KB

event resource

List event resource

get/v1/organizers/{organizerId}/events

Path parameters

organizerIdstring objectId required

Resource identifier.

Query parameters

filtersstring

JSON array of filter objects. Example: [{"status":"active"}]

filtersLogical'$and' | '$or' | '$nor'

Logical operator applied to filters.

limitinteger

Maximum number of items to return.

skipinteger

Number of items to skip.

startIdstring objectId

Start listing after this object id.

sortstring

Sort spec as JSON string. Example: {"_createdAt":"desc"}.

Response

Success

metadataobject

_typestring

Example response

{
  "data": [
    {
      "name": "x",
      "categories": [
        "eventLocations"
      ],
      "ticketContentRules": [
        {
          "providers": [
            {
              "type": "discount"
            }
          ]
        }
      ],
      "optionalForm": true,
      "feesMode": "author",
      "shortDescription": "string",
      "description": "string",
      "tagList": [
        "string"
      ],
      "isPrivate": true,
      "needConfirmation": true,
      "dateRule": "day",
      "invoiceReferencePrefix": "string",
      "taxType": "notApplicable",
      "installments": [
        2
      ],
      "defaultLocale": "fr",
      "orderExpirationDelay": "string",
      "salesDetails": {
        "orderConfirmationText": "string",
        "refundPolicy": "string",
        "terms": "string"
      },
      "theme": {
        "dark": true,
        "primaryColor": "#A1B2C3",
        "secondaryColor": "#A1B2C3"
      },
      "music": [
        {
          "title": "x",
          "description": "string"
        }
      ],
      "testimonials": [
        {
          "name": "x",
          "role": "string",
          "content": "x"
        }
      ],
      "partners": [
        {
          "role": "string",
          "description": "string"
        }
      ],
      "referenceHandler": {
        "regex": "x",
        "hint": "x"
      },
      "slug": "string",
      "status": "draft",
      "_id": "64b7f8b6f23a4a4f3d0a9b12",
      "_createdAt": "2024-01-01T00:00:00.000Z",
      "_updatedAt": "2024-01-01T00:00:00.000Z",
      "_reference": "string"
    }
  ],
  "_type": "event"
}