Cinema Chains

Server

Cinema chains, employees and chain-wide customization.

List chain custom contents

GET

https://api.cineamo.com

/cinema-chains/{cinemaChainId}/custom-contents

List chain-level custom content entries for a cinema chain.

List chain custom contents › path Parameters

cinemaChainId

integer · required

List chain custom contents › query Parameters

page

integer

perPage

integer

sort

string

order

string

query

string

List chain custom contents › Responses

200

List of ChainCustomContent

ChainCustomContent

id

integer · readOnly

cinemaChainId

integer · readOnly

name

string

description

string | null

descriptionEn

string | null

posterImageRef

string | null

posterImageUrl

string | null

Resolved CDN url for the posterImageRef; null when no image is set.

backdropImageRef

string | null

backdropImageUrl

string | null

Resolved CDN url for the backdropImageRef; null when no image is set.

trailerUrl

string | null

ageRating

string | null

duration

integer | null

defaultInherit

boolean

When true, creating this resource pushes INHERITED to every cinema in the chain.

Example: true

position

integer

GET/cinema-chains/{cinemaChainId}/custom-contents

curl https://api.cineamo.com/cinema-chains/:cinemaChainId/custom-contents

Example Responses

{
  "id": 1,
  "cinemaChainId": 42,
  "name": "Summer Blockbuster",
  "description": "A custom content entry",
  "descriptionEn": "An English custom content entry",
  "posterImageRef": "00000000-0000-0000-0000-000000000000",
  "posterImageUrl": "posterImageUrl",
  "backdropImageRef": "00000000-0000-0000-0000-000000000000",
  "backdropImageUrl": "backdropImageUrl",
  "trailerUrl": "https://example.com/trailer.mp4",
  "ageRating": "FSK 12",
  "duration": 120,
  "defaultInherit": true,
  "position": 0
}

application/json

Create a chain custom content

POST

https://api.cineamo.com

/cinema-chains/{cinemaChainId}/custom-contents

Creates a chain custom content. Returns the created chain custom content.

Create a chain custom content › Responses

ChainCustomContent was created

No data returned

POST/cinema-chains/{cinemaChainId}/custom-contents

curl https://api.cineamo.com/cinema-chains/:cinemaChainId/custom-contents \
  --request POST

Example Responses

No example specified for this content type

Get a chain custom content

GET

https://api.cineamo.com

/cinema-chain-custom-contents/{chainCustomContentId}

Returns the requested chain custom content.

Get a chain custom content › Responses

ChainCustomContent

No data returned

GET/cinema-chain-custom-contents/{chainCustomContentId}

curl https://api.cineamo.com/cinema-chain-custom-contents/:chainCustomContentId

Example Responses

No example specified for this content type

Delete a chain custom content

DELETE

https://api.cineamo.com

/cinema-chain-custom-contents/{chainCustomContentId}

Deletes a chain custom content. Returns an empty response.

Delete a chain custom content › Responses

Deleted

No data returned

DELETE/cinema-chain-custom-contents/{chainCustomContentId}

curl https://api.cineamo.com/cinema-chain-custom-contents/:chainCustomContentId \
  --request DELETE

Example Responses

No example specified for this content type

Update a chain custom content

PATCH

https://api.cineamo.com

/cinema-chain-custom-contents/{chainCustomContentId}

Updates a chain custom content. Returns the updated chain custom content.

Update a chain custom content › Responses

200

Updated

No data returned

PATCH/cinema-chain-custom-contents/{chainCustomContentId}

curl https://api.cineamo.com/cinema-chain-custom-contents/:chainCustomContentId \
  --request PATCH

Example Responses

No example specified for this content type

Replace a chain custom content assignment

PUT

https://api.cineamo.com

/cinema-chain-custom-contents/{chainCustomContentId}/cinema/{cinemaId}/assignment

Creates or replaces a chain custom content assignment. Returns the chain custom content assignment.

Replace a chain custom content assignment › Responses

Assignment upserted

No data returned

PUT/cinema-chain-custom-contents/{chainCustomContentId}/cinema/{cinemaId}/assignment

curl https://api.cineamo.com/cinema-chain-custom-contents/:chainCustomContentId/cinema/:cinemaId/assignment \
  --request PUT

Example Responses

No example specified for this content type

Delete a chain custom content assignment

DELETE

https://api.cineamo.com

/cinema-chain-custom-contents/{chainCustomContentId}/cinema/{cinemaId}/assignment

Deletes a chain custom content assignment. Returns an empty response.

Delete a chain custom content assignment › Responses

Assignment cleared (state becomes PENDING)

No data returned

DELETE/cinema-chain-custom-contents/{chainCustomContentId}/cinema/{cinemaId}/assignment

curl https://api.cineamo.com/cinema-chain-custom-contents/:chainCustomContentId/cinema/:cinemaId/assignment \
  --request DELETE

Example Responses

No example specified for this content type

List chain custom content assignments

GET

https://api.cineamo.com

/cinema-chains/{cinemaChainId}/custom-content-assignments

Returns a list of chain custom content assignments objects.

List chain custom content assignments › Responses

200

Inheritance matrix

No data returned

GET/cinema-chains/{cinemaChainId}/custom-content-assignments

curl https://api.cineamo.com/cinema-chains/:cinemaChainId/custom-content-assignments

Example Responses

No example specified for this content type

List chain movie customizations

GET

https://api.cineamo.com

/cinema-chains/{cinemaChainId}/movie-customizations

List chain-level movie customizations for a cinema chain.

List chain movie customizations › path Parameters

cinemaChainId

integer · required

List chain movie customizations › query Parameters

page

integer

perPage

integer

sort

string

order

string

query

string

List chain movie customizations › Responses

200

List of ChainMovieCustomization

ChainMovieCustomization

id

integer · readOnly

cinemaChainId

integer · readOnly

movieId

integer · readOnly

name

string · readOnly

Display/search label (derived from the movie title at create time).

Example: The Dark Knight

title

string | null

description

string | null

posterImageRef

string | null

posterImageUrl

string | null

Resolved CDN url for the posterImageRef; null when no image is set.

backdropImageRef

string | null

backdropImageUrl

string | null

Resolved CDN url for the backdropImageRef; null when no image is set.

preferedTrailerUrl

string | null

isActive

boolean

defaultInherit

boolean

When true, creating this resource pushes INHERITED to every cinema in the chain.

Example: true

position

integer

GET/cinema-chains/{cinemaChainId}/movie-customizations

curl https://api.cineamo.com/cinema-chains/:cinemaChainId/movie-customizations

Example Responses

{
  "id": 1,
  "cinemaChainId": 42,
  "movieId": 965251,
  "name": "The Dark Knight",
  "title": "The Dark Knight",
  "description": "A custom synopsis",
  "posterImageRef": "00000000-0000-0000-0000-000000000000",
  "posterImageUrl": "posterImageUrl",
  "backdropImageRef": "00000000-0000-0000-0000-000000000000",
  "backdropImageUrl": "backdropImageUrl",
  "preferedTrailerUrl": "https://example.com/trailer.mp4",
  "isActive": true,
  "defaultInherit": true,
  "position": 0
}

application/json

Create a chain movie customization

POST

https://api.cineamo.com

/cinema-chains/{cinemaChainId}/movie-customizations

Creates a chain movie customization. Returns the created chain movie customization.

Create a chain movie customization › Responses

ChainMovieCustomization was created

No data returned

POST/cinema-chains/{cinemaChainId}/movie-customizations

curl https://api.cineamo.com/cinema-chains/:cinemaChainId/movie-customizations \
  --request POST

Example Responses

No example specified for this content type

Get a chain movie customization

GET

https://api.cineamo.com

/cinema-chain-movie-customizations/{chainMovieCustomizationId}

Returns the requested chain movie customization.

Get a chain movie customization › Responses

ChainMovieCustomization

No data returned

GET/cinema-chain-movie-customizations/{chainMovieCustomizationId}

curl https://api.cineamo.com/cinema-chain-movie-customizations/:chainMovieCustomizationId

Example Responses

No example specified for this content type

Delete a chain movie customization

DELETE

https://api.cineamo.com

/cinema-chain-movie-customizations/{chainMovieCustomizationId}

Deletes a chain movie customization. Returns an empty response.

Delete a chain movie customization › Responses

Deleted

No data returned

DELETE/cinema-chain-movie-customizations/{chainMovieCustomizationId}

curl https://api.cineamo.com/cinema-chain-movie-customizations/:chainMovieCustomizationId \
  --request DELETE

Example Responses

No example specified for this content type

Update a chain movie customization

PATCH

https://api.cineamo.com

/cinema-chain-movie-customizations/{chainMovieCustomizationId}

Updates a chain movie customization. Returns the updated chain movie customization.

Update a chain movie customization › Responses

200

Updated

No data returned

PATCH/cinema-chain-movie-customizations/{chainMovieCustomizationId}

curl https://api.cineamo.com/cinema-chain-movie-customizations/:chainMovieCustomizationId \
  --request PATCH

Example Responses

No example specified for this content type

Replace a chain movie customization assignment

PUT

https://api.cineamo.com

/cinema-chain-movie-customizations/{chainMovieCustomizationId}/cinema/{cinemaId}/assignment

Creates or replaces a chain movie customization assignment. Returns the chain movie customization assignment.

Replace a chain movie customization assignment › Responses

Assignment upserted

No data returned

PUT/cinema-chain-movie-customizations/{chainMovieCustomizationId}/cinema/{cinemaId}/assignment

curl https://api.cineamo.com/cinema-chain-movie-customizations/:chainMovieCustomizationId/cinema/:cinemaId/assignment \
  --request PUT

Example Responses

No example specified for this content type

Delete a chain movie customization assignment

DELETE

https://api.cineamo.com

/cinema-chain-movie-customizations/{chainMovieCustomizationId}/cinema/{cinemaId}/assignment

Deletes a chain movie customization assignment. Returns an empty response.

Delete a chain movie customization assignment › Responses

Assignment cleared (state becomes PENDING)

No data returned

DELETE/cinema-chain-movie-customizations/{chainMovieCustomizationId}/cinema/{cinemaId}/assignment

curl https://api.cineamo.com/cinema-chain-movie-customizations/:chainMovieCustomizationId/cinema/:cinemaId/assignment \
  --request DELETE

Example Responses

No example specified for this content type

List chain movie customization assignments

GET

https://api.cineamo.com

/cinema-chains/{cinemaChainId}/movie-customization-assignments

Returns a list of chain movie customization assignments objects.

List chain movie customization assignments › Responses

200

Inheritance matrix

No data returned

GET/cinema-chains/{cinemaChainId}/movie-customization-assignments

curl https://api.cineamo.com/cinema-chains/:cinemaChainId/movie-customization-assignments

Example Responses

No example specified for this content type

List chain special tags

GET

https://api.cineamo.com

/cinema-chains/{cinemaChainId}/special-tags

List chain-level special tags for a cinema chain.

List chain special tags › path Parameters

cinemaChainId

integer · required

List chain special tags › query Parameters

page

integer

perPage

integer

sort

string

order

string

query

string

List chain special tags › Responses

200

List of ChainSpecialTag

ChainSpecialTag

id

integer · readOnly

cinemaChainId

integer · readOnly

name

string

color

string | null

description

string | null

imageRef

string | null

imageUrl

string | null

Resolved CDN url for the imageRef; null when no image is set.

defaultInherit

boolean

When true, creating this resource pushes INHERITED to every cinema in the chain.

Example: true

position

integer

GET/cinema-chains/{cinemaChainId}/special-tags

curl https://api.cineamo.com/cinema-chains/:cinemaChainId/special-tags

Example Responses

{
  "id": 1,
  "cinemaChainId": 42,
  "name": "Premiere",
  "color": "#40e587",
  "description": "Big premieres",
  "imageRef": "00000000-0000-0000-0000-000000000000",
  "imageUrl": "imageUrl",
  "defaultInherit": true,
  "position": 0
}

application/json

Create a chain special tag

POST

https://api.cineamo.com

/cinema-chains/{cinemaChainId}/special-tags

Creates a chain special tag. Returns the created chain special tag.

Create a chain special tag › Responses

ChainSpecialTag was created

No data returned

POST/cinema-chains/{cinemaChainId}/special-tags

curl https://api.cineamo.com/cinema-chains/:cinemaChainId/special-tags \
  --request POST

Example Responses

No example specified for this content type

Get a chain special tag

GET

https://api.cineamo.com

/cinema-chain-special-tags/{chainSpecialTagId}

Returns the requested chain special tag.

Get a chain special tag › Responses

ChainSpecialTag

No data returned

GET/cinema-chain-special-tags/{chainSpecialTagId}

curl https://api.cineamo.com/cinema-chain-special-tags/:chainSpecialTagId

Example Responses

No example specified for this content type

Delete a chain special tag

DELETE

https://api.cineamo.com

/cinema-chain-special-tags/{chainSpecialTagId}

Deletes a chain special tag. Returns an empty response.

Delete a chain special tag › Responses

Deleted

No data returned

DELETE/cinema-chain-special-tags/{chainSpecialTagId}

curl https://api.cineamo.com/cinema-chain-special-tags/:chainSpecialTagId \
  --request DELETE

Example Responses

No example specified for this content type

Update a chain special tag

PATCH

https://api.cineamo.com

/cinema-chain-special-tags/{chainSpecialTagId}

Updates a chain special tag. Returns the updated chain special tag.

Update a chain special tag › Responses

200

Updated

No data returned

PATCH/cinema-chain-special-tags/{chainSpecialTagId}

curl https://api.cineamo.com/cinema-chain-special-tags/:chainSpecialTagId \
  --request PATCH

Example Responses

No example specified for this content type

Replace a chain special tag assignment

PUT

https://api.cineamo.com

/cinema-chain-special-tags/{chainSpecialTagId}/cinema/{cinemaId}/assignment

Creates or replaces a chain special tag assignment. Returns the chain special tag assignment.

Replace a chain special tag assignment › Responses

Assignment upserted

No data returned

PUT/cinema-chain-special-tags/{chainSpecialTagId}/cinema/{cinemaId}/assignment

curl https://api.cineamo.com/cinema-chain-special-tags/:chainSpecialTagId/cinema/:cinemaId/assignment \
  --request PUT

Example Responses

No example specified for this content type

Delete a chain special tag assignment

DELETE

https://api.cineamo.com

/cinema-chain-special-tags/{chainSpecialTagId}/cinema/{cinemaId}/assignment

Deletes a chain special tag assignment. Returns an empty response.

Delete a chain special tag assignment › Responses

Assignment cleared (state becomes PENDING)

No data returned

DELETE/cinema-chain-special-tags/{chainSpecialTagId}/cinema/{cinemaId}/assignment

curl https://api.cineamo.com/cinema-chain-special-tags/:chainSpecialTagId/cinema/:cinemaId/assignment \
  --request DELETE

Example Responses

No example specified for this content type

List chain special tag assignments

GET

https://api.cineamo.com

/cinema-chains/{cinemaChainId}/special-tag-assignments

Returns a list of chain special tag assignments objects.

List chain special tag assignments › Responses

200

Inheritance matrix

No data returned

GET/cinema-chains/{cinemaChainId}/special-tag-assignments

curl https://api.cineamo.com/cinema-chains/:cinemaChainId/special-tag-assignments

Example Responses

No example specified for this content type

List cinema chains

GET

https://api.cineamo.com

/cinema-chains

Returns a list of cinema chains objects.

List cinema chains › Responses

200

CinemaChain list

No data returned

Create a cinema chain

POST

https://api.cineamo.com

/cinema-chains

Creates a cinema chain. Returns the created cinema chain.

Create a cinema chain › Request Body

CinemaChain

id

integer · required

name

string

description

string | null

logoUrl

string | null

logoImageRef

string | null

imageUrl

string | null

imageRef

string | null

primaryColor

string | null

slug

string | null

phone

string | null

email

string | null

youthProtectionOfficer

string | null

street

string | null

postalCode

string | null

city

string | null

state

string | null

country

string | null

facebookLink

string | null

instagramLink

string | null

tiktokLink

string | null

youtubeLink

string | null

linkedinLink

string | null

xingLink

string | null

brandImageUrl

string | null

The chain's brand mark for a square or round slot: the chain logo, else the chain image. Mirrors a cinema's brandImageUrl, so a chain-scoped notification campaign can show the icon its push notifications will carry.

Example: https://cdn.example.com/cinema-chain-logo-image/00000000-0000-0000-0000-000000000000

Create a cinema chain › Responses

CinemaChain was created

CinemaChain

id

integer · required

name

string

description

string | null

logoUrl

string | null

logoImageRef

string | null

imageUrl

string | null

imageRef

string | null

primaryColor

string | null

slug

string | null

phone

string | null

email

string | null

youthProtectionOfficer

string | null

street

string | null

postalCode

string | null

city

string | null

state

string | null

country

string | null

facebookLink

string | null

instagramLink

string | null

tiktokLink

string | null

youtubeLink

string | null

linkedinLink

string | null

xingLink

string | null

brandImageUrl

string | null

Example: https://cdn.example.com/cinema-chain-logo-image/00000000-0000-0000-0000-000000000000

POST/cinema-chains

curl https://api.cineamo.com/cinema-chains \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 0,
  "name": "name",
  "description": "description",
  "logoUrl": "logoUrl",
  "logoImageRef": "logoImageRef",
  "imageUrl": "imageUrl",
  "imageRef": "imageRef",
  "primaryColor": "primaryColor",
  "slug": "slug",
  "phone": "phone",
  "email": "email",
  "youthProtectionOfficer": "youthProtectionOfficer",
  "street": "street",
  "postalCode": "postalCode",
  "city": "city",
  "state": "state",
  "country": "country",
  "facebookLink": "facebookLink",
  "instagramLink": "instagramLink",
  "tiktokLink": "tiktokLink",
  "youtubeLink": "youtubeLink",
  "linkedinLink": "linkedinLink",
  "xingLink": "xingLink",
  "brandImageUrl": "https://cdn.example.com/cinema-chain-logo-image/00000000-0000-0000-0000-000000000000"
}'

Example Request Body

{
  "id": 0,
  "name": "name",
  "description": "description",
  "logoUrl": "logoUrl",
  "logoImageRef": "logoImageRef",
  "imageUrl": "imageUrl",
  "imageRef": "imageRef",
  "primaryColor": "primaryColor",
  "slug": "slug",
  "phone": "phone",
  "email": "email",
  "youthProtectionOfficer": "youthProtectionOfficer",
  "street": "street",
  "postalCode": "postalCode",
  "city": "city",
  "state": "state",
  "country": "country",
  "facebookLink": "facebookLink",
  "instagramLink": "instagramLink",
  "tiktokLink": "tiktokLink",
  "youtubeLink": "youtubeLink",
  "linkedinLink": "linkedinLink",
  "xingLink": "xingLink",
  "brandImageUrl": "https://cdn.example.com/cinema-chain-logo-image/00000000-0000-0000-0000-000000000000"
}

Example Responses

{
  "id": 0,
  "name": "name",
  "description": "description",
  "logoUrl": "logoUrl",
  "logoImageRef": "logoImageRef",
  "imageUrl": "imageUrl",
  "imageRef": "imageRef",
  "primaryColor": "primaryColor",
  "slug": "slug",
  "phone": "phone",
  "email": "email",
  "youthProtectionOfficer": "youthProtectionOfficer",
  "street": "street",
  "postalCode": "postalCode",
  "city": "city",
  "state": "state",
  "country": "country",
  "facebookLink": "facebookLink",
  "instagramLink": "instagramLink",
  "tiktokLink": "tiktokLink",
  "youtubeLink": "youtubeLink",
  "linkedinLink": "linkedinLink",
  "xingLink": "xingLink",
  "brandImageUrl": "https://cdn.example.com/cinema-chain-logo-image/00000000-0000-0000-0000-000000000000"
}

application/json

Get a cinema chain

GET

https://api.cineamo.com

/cinema-chains/{cinemaChainId}

Returns the requested cinema chain.

Get a cinema chain › path Parameters

cinemaChainId

integer · required

Get a cinema chain › Responses

CinemaChain details

No data returned

GET/cinema-chains/{cinemaChainId}

curl https://api.cineamo.com/cinema-chains/:cinemaChainId

Example Responses

No example specified for this content type

Delete a cinema chain

DELETE

https://api.cineamo.com

/cinema-chains/{cinemaChainId}

Deletes a cinema chain. Returns an empty response.

Delete a cinema chain › path Parameters

cinemaChainId

integer · required

Delete a cinema chain › Responses

CinemaChain was deleted

No data returned

DELETE/cinema-chains/{cinemaChainId}

curl https://api.cineamo.com/cinema-chains/:cinemaChainId \
  --request DELETE

Example Responses

No example specified for this content type

Update a cinema chain

PATCH

https://api.cineamo.com

/cinema-chains/{cinemaChainId}

Updates a cinema chain. Returns the updated cinema chain.

Update a cinema chain › path Parameters

cinemaChainId

integer · required

Update a cinema chain › Request Body

CinemaChain

id

integer · required

name

string

description

string | null

logoUrl

string | null

logoImageRef

string | null

imageUrl

string | null

imageRef

string | null

primaryColor

string | null

slug

string | null

phone

string | null

email

string | null

youthProtectionOfficer

string | null

street

string | null

postalCode

string | null

city

string | null

state

string | null

country

string | null

facebookLink

string | null

instagramLink

string | null

tiktokLink

string | null

youtubeLink

string | null

linkedinLink

string | null

xingLink

string | null

brandImageUrl

string | null

Example: https://cdn.example.com/cinema-chain-logo-image/00000000-0000-0000-0000-000000000000

Update a cinema chain › Responses

CinemaChain was updated

CinemaChain

id

integer · required

name

string

description

string | null

logoUrl

string | null

logoImageRef

string | null

imageUrl

string | null

imageRef

string | null

primaryColor

string | null

slug

string | null

phone

string | null

email

string | null

youthProtectionOfficer

string | null

street

string | null

postalCode

string | null

city

string | null

state

string | null

country

string | null

facebookLink

string | null

instagramLink

string | null

tiktokLink

string | null

youtubeLink

string | null

linkedinLink

string | null

xingLink

string | null

brandImageUrl

string | null

Example: https://cdn.example.com/cinema-chain-logo-image/00000000-0000-0000-0000-000000000000

PATCH/cinema-chains/{cinemaChainId}

curl https://api.cineamo.com/cinema-chains/:cinemaChainId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 0,
  "name": "name",
  "description": "description",
  "logoUrl": "logoUrl",
  "logoImageRef": "logoImageRef",
  "imageUrl": "imageUrl",
  "imageRef": "imageRef",
  "primaryColor": "primaryColor",
  "slug": "slug",
  "phone": "phone",
  "email": "email",
  "youthProtectionOfficer": "youthProtectionOfficer",
  "street": "street",
  "postalCode": "postalCode",
  "city": "city",
  "state": "state",
  "country": "country",
  "facebookLink": "facebookLink",
  "instagramLink": "instagramLink",
  "tiktokLink": "tiktokLink",
  "youtubeLink": "youtubeLink",
  "linkedinLink": "linkedinLink",
  "xingLink": "xingLink",
  "brandImageUrl": "https://cdn.example.com/cinema-chain-logo-image/00000000-0000-0000-0000-000000000000"
}'

Example Request Body

{
  "id": 0,
  "name": "name",
  "description": "description",
  "logoUrl": "logoUrl",
  "logoImageRef": "logoImageRef",
  "imageUrl": "imageUrl",
  "imageRef": "imageRef",
  "primaryColor": "primaryColor",
  "slug": "slug",
  "phone": "phone",
  "email": "email",
  "youthProtectionOfficer": "youthProtectionOfficer",
  "street": "street",
  "postalCode": "postalCode",
  "city": "city",
  "state": "state",
  "country": "country",
  "facebookLink": "facebookLink",
  "instagramLink": "instagramLink",
  "tiktokLink": "tiktokLink",
  "youtubeLink": "youtubeLink",
  "linkedinLink": "linkedinLink",
  "xingLink": "xingLink",
  "brandImageUrl": "https://cdn.example.com/cinema-chain-logo-image/00000000-0000-0000-0000-000000000000"
}

Example Responses

{
  "id": 0,
  "name": "name",
  "description": "description",
  "logoUrl": "logoUrl",
  "logoImageRef": "logoImageRef",
  "imageUrl": "imageUrl",
  "imageRef": "imageRef",
  "primaryColor": "primaryColor",
  "slug": "slug",
  "phone": "phone",
  "email": "email",
  "youthProtectionOfficer": "youthProtectionOfficer",
  "street": "street",
  "postalCode": "postalCode",
  "city": "city",
  "state": "state",
  "country": "country",
  "facebookLink": "facebookLink",
  "instagramLink": "instagramLink",
  "tiktokLink": "tiktokLink",
  "youtubeLink": "youtubeLink",
  "linkedinLink": "linkedinLink",
  "xingLink": "xingLink",
  "brandImageUrl": "https://cdn.example.com/cinema-chain-logo-image/00000000-0000-0000-0000-000000000000"
}

application/json

List cinema chain employees

GET

https://api.cineamo.com

/cinema-chains/{cinemaChainId}/employees

Returns a list of cinema chain employees objects.

List cinema chain employees › path Parameters

cinemaChainId

integer · required

List cinema chain employees › Responses

CinemaChain HQ employee list

No data returned

GET/cinema-chains/{cinemaChainId}/employees

curl https://api.cineamo.com/cinema-chains/:cinemaChainId/employees

Example Responses

No example specified for this content type

Add a cinema chain employee

POST

https://api.cineamo.com

/cinema-chains/{cinemaChainId}/employees

Creates a cinema chain employee. Returns the created cinema chain employee.

Add a cinema chain employee › path Parameters

cinemaChainId

integer · required

Add a cinema chain employee › Request Body

userId

integer

Add a cinema chain employee › Responses

HQ employee added

No data returned

POST/cinema-chains/{cinemaChainId}/employees

curl https://api.cineamo.com/cinema-chains/:cinemaChainId/employees \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "userId": 0
}'

Example Request Body

{
  "userId": 0
}

Example Responses

No example specified for this content type

Get a cinema chain employee

GET

https://api.cineamo.com

/cinema-chains/{cinemaChainId}/employees/{userId}

Returns the requested cinema chain employee.

Get a cinema chain employee › path Parameters

cinemaChainId

integer · required

userId

integer · required

Get a cinema chain employee › Responses

CinemaChain HQ employee

No data returned

GET/cinema-chains/{cinemaChainId}/employees/{userId}

curl https://api.cineamo.com/cinema-chains/:cinemaChainId/employees/:userId

Example Responses

No example specified for this content type

Remove a cinema chain employee

DELETE

https://api.cineamo.com

/cinema-chains/{cinemaChainId}/employees/{userId}

Deletes a cinema chain employee. Returns an empty response.

Remove a cinema chain employee › path Parameters

cinemaChainId

integer · required

userId

integer · required

Remove a cinema chain employee › Responses

HQ employee removed

No data returned

DELETE/cinema-chains/{cinemaChainId}/employees/{userId}

curl https://api.cineamo.com/cinema-chains/:cinemaChainId/employees/:userId \
  --request DELETE

Example Responses

No example specified for this content type

Update a cinema chain employee

PATCH

https://api.cineamo.com

/cinema-chains/{cinemaChainId}/employees/{userId}

Updates a cinema chain employee. Returns the updated cinema chain employee.

Update a cinema chain employee › path Parameters

cinemaChainId

integer · required

userId

integer · required

Update a cinema chain employee › Request Body

isChainAdmin

boolean

cinemaIds

integer[]

Update a cinema chain employee › Responses

Employee updated

No data returned

PATCH/cinema-chains/{cinemaChainId}/employees/{userId}

curl https://api.cineamo.com/cinema-chains/:cinemaChainId/employees/:userId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --data '{
  "isChainAdmin": true,
  "cinemaIds": [
    0
  ]
}'

Example Request Body

{
  "isChainAdmin": true,
  "cinemaIds": [
    0
  ]
}

Example Responses

No example specified for this content type

Invite cinema chain employee

POST

https://api.cineamo.com

/cinema-chains/{cinemaChainId}/employees/invite

Invites cinema chain employee.

Invite cinema chain employee › path Parameters

cinemaChainId

integer · required

Invite cinema chain employee › Request Body

email

string

isChainAdmin

boolean

cinemaIds

integer[]

Invite cinema chain employee › Responses

Existing user attached

No data returned

POST/cinema-chains/{cinemaChainId}/employees/invite

curl https://api.cineamo.com/cinema-chains/:cinemaChainId/employees/invite \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "email",
  "isChainAdmin": true,
  "cinemaIds": [
    0
  ]
}'

Example Request Body

{
  "email": "email",
  "isChainAdmin": true,
  "cinemaIds": [
    0
  ]
}

Example Responses

No example specified for this content type

Cinema Cards Cinema Companies