> ## Documentation Index > Fetch the complete documentation index at: https://docs.amply-app.com/llms.txt > Use this file to discover all available pages before exploring further. # Get broadcastMap resource ## OpenAPI ````yaml https://api.amply-app.com/v1/openapi.json get /v1/users/{userId}/broadcasts/{broadcastId}/broadcastMaps/{broadcastMapId} openapi: 3.1.0 info: title: Amply API version: 1.0.0 description: >- Authentication: send your API key in the `X-API-KEY` header. Each API key is tied to a single broadcast. A key cannot manage multiple broadcasts. API keys can be generated from the broadcast developer settings. servers: - url: https://api.amply-app.com security: - ApiKeyAuth: [] tags: - name: broadcastEvent resource description: API endpoints for managing broadcastEvent resources x-tag-schema: $ref: '#/components/schemas/broadcastEventResponse' x-tag-schema-example: type: app.opened metadata: {} _id: 64b7f8b6f23a4a4f3d0a9b12 _createdAt: '2024-01-01T00:00:00.000Z' - name: broadcastNetworkingForm resource description: API endpoints for managing broadcastNetworkingForm resources x-tag-schema: $ref: '#/components/schemas/broadcastNetworkingForm' x-tag-schema-example: _id: 64b7f8b6f23a4a4f3d0a9b12 _createdAt: '2024-01-01T00:00:00.000Z' - name: media resource description: API endpoints for managing media resources x-tag-schema: $ref: '#/components/schemas/media' x-tag-schema-example: _id: 64b7f8b6f23a4a4f3d0a9b12 _userId: string mediaUrl: string external: true _createdAt: '2024-01-01T00:00:00.000Z' - name: broadcastContact resource description: API endpoints for managing broadcastContact resources x-tag-schema: $ref: '#/components/schemas/broadcastContact' x-tag-schema-example: _id: 64b7f8b6f23a4a4f3d0a9b12 _createdAt: '2024-01-01T00:00:00.000Z' - name: broadcastCategory resource description: API endpoints for managing broadcastCategory resources x-tag-schema: $ref: '#/components/schemas/broadcastCategory' x-tag-schema-example: status: draft _id: 64b7f8b6f23a4a4f3d0a9b12 _createdAt: '2024-01-01T00:00:00.000Z' - name: broadcastClient resource description: API endpoints for managing broadcastClient resources x-tag-schema: $ref: '#/components/schemas/broadcastClient' x-tag-schema-example: _id: 64b7f8b6f23a4a4f3d0a9b12 _createdAt: '2024-01-01T00:00:00.000Z' - name: broadcastDiffuser resource description: API endpoints for managing broadcastDiffuser resources x-tag-schema: $ref: '#/components/schemas/broadcastDiffuser' x-tag-schema-example: type: webSite seo: title: string metaDescription: string indexing: true _id: 64b7f8b6f23a4a4f3d0a9b12 _createdAt: '2024-01-01T00:00:00.000Z' - name: broadcastCampaign resource description: API endpoints for managing broadcastCampaign resources x-tag-schema: $ref: '#/components/schemas/broadcastCampaign' x-tag-schema-example: _id: 64b7f8b6f23a4a4f3d0a9b12 _createdAt: '2024-01-01T00:00:00.000Z' - name: broadcastArticle resource description: API endpoints for managing broadcastArticle resources x-tag-schema: $ref: '#/components/schemas/broadcastArticle' x-tag-schema-example: status: draft blocks: - type: media _id: 64b7f8b6f23a4a4f3d0a9b12 _createdAt: '2024-01-01T00:00:00.000Z' - name: broadcast resource description: API endpoints for managing broadcast resources x-tag-schema: $ref: '#/components/schemas/broadcast' x-tag-schema-example: name: x _id: 64b7f8b6f23a4a4f3d0a9b12 _createdAt: '2024-01-01T00:00:00.000Z' - name: broadcastHost resource description: API endpoints for managing broadcastHost resources x-tag-schema: $ref: '#/components/schemas/broadcastHost' x-tag-schema-example: name: x status: draft _id: 64b7f8b6f23a4a4f3d0a9b12 _createdAt: '2024-01-01T00:00:00.000Z' - name: broadcastInterestPoint resource description: API endpoints for managing broadcastInterestPoint resources x-tag-schema: $ref: '#/components/schemas/broadcastInterestPoint' x-tag-schema-example: mapId: 64b7f8b6f23a4a4f3d0a9b12 status: draft _id: 64b7f8b6f23a4a4f3d0a9b12 _createdAt: '2024-01-01T00:00:00.000Z' - name: broadcastMap resource description: API endpoints for managing broadcastMap resources x-tag-schema: $ref: '#/components/schemas/broadcastMap' x-tag-schema-example: type: image status: draft metadata: {} - name: broadcastMember resource description: API endpoints for managing broadcastMember resources x-tag-schema: $ref: '#/components/schemas/broadcastMember' x-tag-schema-example: email: user@example.com _id: 64b7f8b6f23a4a4f3d0a9b12 _createdAt: '2024-01-01T00:00:00.000Z' - name: broadcastPage resource description: API endpoints for managing broadcastPage resources x-tag-schema: $ref: '#/components/schemas/broadcastPage' x-tag-schema-example: status: draft blocks: - type: media _id: 64b7f8b6f23a4a4f3d0a9b12 _createdAt: '2024-01-01T00:00:00.000Z' - name: revision resource description: API endpoints for managing revision resources x-tag-schema: $ref: '#/components/schemas/revision' x-tag-schema-example: tos: accepted: true _id: 64b7f8b6f23a4a4f3d0a9b12 _createdAt: '2024-01-01T00:00:00.000Z' - name: broadcastSession resource description: API endpoints for managing broadcastSession resources x-tag-schema: $ref: '#/components/schemas/broadcastSession' x-tag-schema-example: status: draft time: {} blocks: - type: media _id: 64b7f8b6f23a4a4f3d0a9b12 _createdAt: '2024-01-01T00:00:00.000Z' - name: workflow resource description: API endpoints for managing workflow resources x-tag-schema: $ref: '#/components/schemas/workflow' x-tag-schema-example: entryNodeId: x nodes: - id: x position: - 0 - 0 type: amply config: operation: type: string value: string resource: type: string value: string name: x _id: 64b7f8b6f23a4a4f3d0a9b12 _createdAt: '2024-01-01T00:00:00.000Z' - name: workflowRun resource description: API endpoints for managing workflowRun resources x-tag-schema: $ref: '#/components/schemas/workflowRun' x-tag-schema-example: status: running durationMs: 0 invokedNodeCount: 0 context: {} nodeResults: - executionId: x index: 0 nodeId: x nodeType: amply routeTaken: onSuccess durationMs: 0 _id: 64b7f8b6f23a4a4f3d0a9b12 _createdAt: '2024-01-01T00:00:00.000Z' - name: font resource description: API endpoints for managing font resources x-tag-schema: $ref: '#/components/schemas/font' x-tag-schema-example: fontFamily: string weights: - weight: 0 url: https://example.com _id: 64b7f8b6f23a4a4f3d0a9b12 _createdAt: '2024-01-01T00:00:00.000Z' paths: /v1/users/{userId}/broadcasts/{broadcastId}/broadcastMaps/{broadcastMapId}: get: tags: - broadcastMap resource summary: Get broadcastMap resource parameters: - name: userId in: path required: true description: Resource identifier. schema: type: string format: objectId example: 64b7f8b6f23a4a4f3d0a9b12 - name: broadcastId in: path required: true description: Resource identifier. schema: type: string format: objectId example: 64b7f8b6f23a4a4f3d0a9b12 - name: broadcastMapId in: path required: true description: Resource identifier. schema: type: string format: objectId example: 64b7f8b6f23a4a4f3d0a9b12 responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/broadcastMap' components: schemas: broadcastMap: allOf: - oneOf: - type: object properties: type: type: string enum: - image description: Type de carte (`interactive`, `image`). example: image status: description: Statut editorial (`draft`, `published`). default: draft type: string enum: - draft - published name: description: Nom de la carte. nullable: true type: string minLength: 1 maxLength: 100 example: x configuration: description: Configuration de la carte. nullable: true type: object properties: initialZoom: description: Niveau de zoom initial de la carte. nullable: true type: number example: 0 initialTilt: description: Inclinaison initiale de la carte. nullable: true type: number example: 0 initialRotation: description: Rotation initiale de la carte. nullable: true type: number example: 0 showUserLocation: description: Affiche la position de l'utilisateur. nullable: true type: boolean example: true enableInterestPointNavigation: description: Active la navigation entre les points d'interet. nullable: true type: boolean example: true enablePanGestures: description: Autorise le deplacement de la carte. nullable: true type: boolean example: true enableZoomGestures: description: Autorise le zoom gestuel. nullable: true type: boolean example: true enableRotateGestures: description: Autorise la rotation gestuelle. nullable: true type: boolean example: true enableTiltGestures: description: Autorise l'inclinaison gestuelle. nullable: true type: boolean example: true backgroundColor: description: Couleur de fond de la carte image. nullable: true type: string pattern: ^#(?:[A-Fa-f0-9]{3,4}|[A-Fa-f0-9]{6}|[A-Fa-f0-9]{8})$ example: '#A1B2C3' opacity: description: Opacite de la carte image. nullable: true type: number example: 0 size: description: Taille de la carte image. nullable: true type: number example: 0 media: description: Image de plan/import statique. nullable: true not: {} layers: description: Layers affiches au-dessus de la carte. nullable: true type: array items: oneOf: - type: object properties: key: description: >- Clé unique du layer (générée automatiquement si non fournie). nullable: true type: string example: string type: type: string enum: - media description: Type de layer (`media`). example: media media: description: Media affiche dans le layer. nullable: true not: {} position: description: Position `[x, y]` du layer. nullable: true type: array items: anyOf: - type: number example: 0 - type: number example: 0 minItems: 2 maxItems: 2 rotation: description: Rotation du layer (en radians). nullable: true type: number example: 0 size: description: Taille du marqueur. nullable: true type: array items: anyOf: - type: number minimum: 0 example: 0 - type: number minimum: 0 example: 0 minItems: 2 maxItems: 2 opacity: description: Opacite du layer. nullable: true type: number example: 0 required: - type description: Layer media d'une carte. title: media description: Layer d'une carte. required: - type - status description: Carte image d'un broadcast. title: image - type: object properties: type: type: string enum: - interactive description: Type de carte (`interactive`, `image`). example: interactive name: description: Nom de la carte. nullable: true type: string minLength: 1 maxLength: 100 example: x configuration: description: Configuration de la carte. nullable: true type: object properties: initialZoom: description: Niveau de zoom initial de la carte. nullable: true type: number example: 0 initialTilt: description: Inclinaison initiale de la carte. nullable: true type: number example: 0 initialRotation: description: Rotation initiale de la carte. nullable: true type: number example: 0 showUserLocation: description: Affiche la position de l'utilisateur. nullable: true type: boolean example: true enableInterestPointNavigation: description: Active la navigation entre les points d'interet. nullable: true type: boolean example: true enablePanGestures: description: Autorise le deplacement de la carte. nullable: true type: boolean example: true enableZoomGestures: description: Autorise le zoom gestuel. nullable: true type: boolean example: true enableRotateGestures: description: Autorise la rotation gestuelle. nullable: true type: boolean example: true enableTiltGestures: description: Autorise l'inclinaison gestuelle. nullable: true type: boolean example: true place: description: Lieu principal de la carte interactive. nullable: true type: object properties: geometry: nullable: true type: object properties: type: nullable: true type: string enum: - point - polygon example: point coordinates: minItems: 2 type: array items: type: number example: 0 required: - coordinates address: nullable: true type: string minLength: 1 maxLength: 200 example: x timezone: nullable: true type: string minLength: 1 maxLength: 100 example: x name: nullable: true type: string minLength: 1 maxLength: 100 example: x addressComponents: nullable: true type: object properties: city: type: string minLength: 1 example: x country: type: string minLength: 1 example: x postalCode: type: string minLength: 1 example: x street: type: string minLength: 1 example: x streetDetails: nullable: true type: string minLength: 1 example: x region: nullable: true type: string minLength: 1 example: x subRegion: nullable: true type: string minLength: 1 example: x name: nullable: true type: string minLength: 1 example: x required: - city - country - postalCode - street status: description: Statut editorial (`draft`, `published`). default: draft type: string enum: - draft - published zoom: description: Niveau de zoom souhaite. nullable: true type: number minimum: 0 example: 0 showElevation: description: Affiche le relief de la carte interactive. nullable: true type: boolean example: true showContourLines: description: Affiche les courbes de niveau de la carte interactive. nullable: true type: boolean example: true style: description: Style de rendu de la carte interactive. nullable: true type: object properties: {} additionalProperties: {} layers: description: Layers affiches au-dessus de la carte. nullable: true type: array items: oneOf: - type: object properties: key: description: >- Clé unique du layer (générée automatiquement si non fournie). nullable: true type: string example: string type: type: string enum: - media description: Type de layer (`media`). example: media media: description: Media affiche dans le layer. nullable: true not: {} position: description: Position `[x, y]` du layer. nullable: true type: array items: anyOf: - type: number example: 0 - type: number example: 0 minItems: 2 maxItems: 2 rotation: description: Rotation du layer (en radians). nullable: true type: number example: 0 size: description: Taille du marqueur. nullable: true type: array items: anyOf: - type: number minimum: 0 example: 0 - type: number minimum: 0 example: 0 minItems: 2 maxItems: 2 opacity: description: Opacite du layer. nullable: true type: number example: 0 required: - type description: Layer media d'une carte. title: media description: Layer d'une carte. required: - type - status description: Carte interactive d'un broadcast. title: interactive description: Carte d'un broadcast Amply. - type: object properties: metadata: type: object additionalProperties: {} properties: _id: type: string format: objectId example: 64b7f8b6f23a4a4f3d0a9b12 _createdAt: type: string format: date-time example: '2024-01-01T00:00:00.000Z' _updatedAt: type: string format: date-time nullable: true example: '2024-01-01T00:00:00.000Z' _reference: nullable: true type: string example: string required: - _id - _createdAt securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-API-KEY description: >- Use the format `X-API-KEY YOUR_API_KEY`. Each key is tied to a single broadcast. ```` ## Related topics - [Delete broadcastMap resource](/api-reference/broadcastmap-resource/delete-broadcastmap-resource.md) - [Create broadcastMap resource](/api-reference/broadcastmap-resource/create-broadcastmap-resource.md) - [List broadcastMap resource](/api-reference/broadcastmap-resource/list-broadcastmap-resource.md) - [Update broadcastMap resource](/api-reference/broadcastmap-resource/update-broadcastmap-resource.md) - [Get broadcast resource](/api-reference/broadcast-resource/get-broadcast-resource.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.