read-api: artists

Mittels read-api können Daten via HTTP abgerufen werden, um sie beispielsweise programmatisch auf einer Webseite auszuspielen oder auch eine Integration mit einem externen System herzustellen.

Authentifizierung

Infos über Authentifizierung, Status Codes und Code Beispiele

Endpunkte

Aktuell stehen folgende Endpunkte zur Verfügung:

  • GET /artists (zur Abfrage einer Liste an Künstler:innen)
  • GET /artist/:slug (zur Abfrage einer:s einzelnen Künstler:in)
  • GET /artist/:slug/events (zur Abfrage der Events einer/s einzelnen Künstler:in)

Alle weiteren technischen Informationen findest du auf der read-api: events Seite.

GET /artists

Zur Abfrage einer Liste an Künstler:innen.

Parameter

Parameter für Filter, Pagination und Sortierung können im Query-String angegeben werden.

Artist-Filter

KeyTyp bzw. Wert
filter.nameSuchtext für Artist-Name

Pagination

KeyTyp bzw. Wert
pagination.takeMaximale Anzahl zurückgegebener Events pro Aufruf
Default: 100
pagination.skipZu überspringende Events
Default: 0

Sortierung

KeyTyp bzw. Wert
sort.column„status“ | „eventType“ | „start“ | „rooms“
Default: „start“
sort.direction„asc“ | „desc“
Default: „asc“

Artist Payload

export interface ArtistExportPayload {
  slug: string
  name: string
  description?: string
  memo?: string
  images?: ArtistExportPayloadImage[]
  files?: ArtistExportPayloadFile[]
  links?: ArtistExportPayloadLink[]
  contacts?: {
    role: string
    displayName: string
    email: string
    phone: string
  }[]
  shows?: {
    slug: string
    name: string
    releasesAt?: Date
    memo?: string
    images?: ArtistExportPayloadImage[]
    files?: ArtistExportPayloadFile[]
    showInformations?: (Information | undefined)[]
  }[]
  artistInformations?: (Information | undefined)[]
}

export type Information = {
  name: string
  value: string
  tags?: string[]
}

export type ArtistEventsRooms = {
  name: string
  location: string
  address?: {
    street: string
    addStreet: string
    zip: string
    city: string
    country: string
  }
}

export type ArtistExportPayloadImage = {
  name: string
  description: string
  tags: string[]
  sizes: Record<string, string>
}

export type ArtistExportPayloadFile = {
  name: string
  description: string
  path: string
  preview: string
  download: string
  tags: string[]
}

export type ArtistExportPayloadLink = {
  type: string
  value: string
}

Bilder

Jedes Bild wird mit den folgenden Informationen und Bildgrößen ausgespielt.

name: 
description: string
sizes: [640, 750, 828, 1080, 1200, 1920, 2048, 3840]

Dateien

Sollen Dateien oder Bilder mit ausgespielt werden, müssen diese auf öffentlich gesetzt werden. Vertrauliche Dateien und Bilder werden nicht ausgespielt.