Buddy Groups

Server

Buddy groups and invitations.

List buddy groups

GET

https://api.cineamo.com

/buddy-groups

Returns a list of BuddyGroup objects.

List buddy groups › query Parameters

page

integer

perPage

integer

sort

string

order

string

List buddy groups › Responses

200

BuddyGroup list

BuddyGroup

id

integer · readOnly

name

string · readOnly

slug

string · readOnly

description

string | null · readOnly

profileImageRef

string | null · readOnly

profileImageUrl

string | null · readOnly

backgroundImageRef

string | null · readOnly

backgroundImageUrl

string | null · readOnly

creatorId

integer | null · readOnly

Create a buddy group

POST

https://api.cineamo.com

/buddy-groups

Creates a BuddyGroup. It returns the BuddyGroup object.

Create a buddy group › Request Body

BuddyGroup

id

integer · readOnly

name

string · readOnly

slug

string · readOnly

description

string | null · readOnly

profileImageRef

string | null · readOnly

profileImageUrl

string | null · readOnly

backgroundImageRef

string | null · readOnly

backgroundImageUrl

string | null · readOnly

creatorId

integer | null · readOnly

Create a buddy group › Responses

BuddyGroup was created

BuddyGroup

id

integer · readOnly

name

string · readOnly

slug

string · readOnly

description

string | null · readOnly

profileImageRef

string | null · readOnly

profileImageUrl

string | null · readOnly

backgroundImageRef

string | null · readOnly

backgroundImageUrl

string | null · readOnly

creatorId

integer | null · readOnly

POST/buddy-groups

curl https://api.cineamo.com/buddy-groups \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "name": "A",
  "slug": "some-buddy-group-name",
  "description": "description",
  "profileImageRef": "00000000-0000-0000-0000-000000000000",
  "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/buddy-group-profile",
  "backgroundImageRef": "00000000-0000-0000-0000-000000000000",
  "backgroundImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/buddy-group-logo",
  "creatorId": 1
}'

Example Request Body

{
  "id": 1,
  "name": "A",
  "slug": "some-buddy-group-name",
  "description": "description",
  "profileImageRef": "00000000-0000-0000-0000-000000000000",
  "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/buddy-group-profile",
  "backgroundImageRef": "00000000-0000-0000-0000-000000000000",
  "backgroundImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/buddy-group-logo",
  "creatorId": 1
}

json

Example Responses

{
  "id": 1,
  "name": "A",
  "slug": "some-buddy-group-name",
  "description": "description",
  "profileImageRef": "00000000-0000-0000-0000-000000000000",
  "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/buddy-group-profile",
  "backgroundImageRef": "00000000-0000-0000-0000-000000000000",
  "backgroundImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/buddy-group-logo",
  "creatorId": 1
}

json

application/json

Get a buddy group

GET

https://api.cineamo.com

/buddy-groups/{buddyGroupId}

Returns a BuddyGroup object by its Id.

Get a buddy group › path Parameters

buddyGroupId

integer · required

Get a buddy group › Responses

BuddyGroup details

BuddyGroup

id

integer · readOnly

name

string · readOnly

slug

string · readOnly

description

string | null · readOnly

profileImageRef

string | null · readOnly

profileImageUrl

string | null · readOnly

backgroundImageRef

string | null · readOnly

backgroundImageUrl

string | null · readOnly

creatorId

integer | null · readOnly

Delete a buddy group

DELETE

https://api.cineamo.com

/buddy-groups/{buddyGroupId}

Deletes a BuddyGroup. It returns an empty response.

Delete a buddy group › path Parameters

buddyGroupId

string · required

Delete a buddy group › Responses

BuddyGroup was deleted

No data returned

Update a buddy group

PATCH

https://api.cineamo.com

/buddy-groups/{buddyGroupId}

Updates a BuddyGroup. It returns the updated BuddyGroup object.

Update a buddy group › path Parameters

buddyGroupId

integer · required

Update a buddy group › Request Body

BuddyGroup

id

integer · readOnly

name

string · readOnly

slug

string · readOnly

description

string | null · readOnly

profileImageRef

string | null · readOnly

profileImageUrl

string | null · readOnly

backgroundImageRef

string | null · readOnly

backgroundImageUrl

string | null · readOnly

creatorId

integer | null · readOnly

Update a buddy group › Responses

BuddyGroup was updated

BuddyGroup

id

integer · readOnly

name

string · readOnly

slug

string · readOnly

description

string | null · readOnly

profileImageRef

string | null · readOnly

profileImageUrl

string | null · readOnly

backgroundImageRef

string | null · readOnly

backgroundImageUrl

string | null · readOnly

creatorId

integer | null · readOnly

PATCH/buddy-groups/{buddyGroupId}

curl https://api.cineamo.com/buddy-groups/:buddyGroupId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "name": "A",
  "slug": "some-buddy-group-name",
  "description": "description",
  "profileImageRef": "00000000-0000-0000-0000-000000000000",
  "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/buddy-group-profile",
  "backgroundImageRef": "00000000-0000-0000-0000-000000000000",
  "backgroundImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/buddy-group-logo",
  "creatorId": 1
}'

Example Request Body

{
  "id": 1,
  "name": "A",
  "slug": "some-buddy-group-name",
  "description": "description",
  "profileImageRef": "00000000-0000-0000-0000-000000000000",
  "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/buddy-group-profile",
  "backgroundImageRef": "00000000-0000-0000-0000-000000000000",
  "backgroundImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/buddy-group-logo",
  "creatorId": 1
}

json

Example Responses

{
  "id": 1,
  "name": "A",
  "slug": "some-buddy-group-name",
  "description": "description",
  "profileImageRef": "00000000-0000-0000-0000-000000000000",
  "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/buddy-group-profile",
  "backgroundImageRef": "00000000-0000-0000-0000-000000000000",
  "backgroundImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/buddy-group-logo",
  "creatorId": 1
}

json

application/json

Delete a member

DELETE

https://api.cineamo.com

/buddy-groups/{buddyGroupId}/members/{memberId}

Deletes a buddy group member. It returns a response code but no response data.

Delete a member › path Parameters

memberId

integer · required

buddyGroupId

integer · required

Delete a member › Responses

userBuddyGroupMember was deleted

No data returned

List buddy group members

GET

https://api.cineamo.com

/buddy-groups/{buddyGroupId}/members

Returns a list of User objects (buddy group members).

List buddy group members › path Parameters

buddyGroupId

integer · required

List buddy group members › query Parameters

page

integer

perPage

integer

sort

string

order

string

List buddy group members › Responses

200

A list of User objects

User[]

User

id

integer | null · readOnly

username

string | null · readOnly

firstName

string | null · readOnly

lastName

string | null · readOnly

profileImageRef

string | null · readOnly

profileImageUrl

string | null · readOnly

isActivated

boolean | null · readOnly

isDeleted

boolean | null · readOnly

lastAccessTokenDatetime

string | null · readOnly

Accept buddy group invitation

POST

https://api.cineamo.com

/buddy-group-invitations/{buddyGroupInvitationId:\d+}/accept

Sets a buddy group member. It returns the BuddyGroupInvitation object.

Accept buddy group invitation › path Parameters

buddyGroupInvitationId

integer · required

Accept buddy group invitation › Request Body

BuddyGroupInvitation

id

integer · readOnly

buddyGroupId

integer | null · readOnly

issuerId

integer | null · readOnly

CinApi\User\Dto\UserDtoInterface | null · readOnly

expireDatetime

string | null · readOnly

acceptedDatetime

string | null · readOnly

declinedDatetime

string | null · readOnly

Accept buddy group invitation › Responses

200

BuddyGroupInvitation was accepted

BuddyGroupInvitation

id

integer · readOnly

buddyGroupId

integer | null · readOnly

issuerId

integer | null · readOnly

CinApi\User\Dto\UserDtoInterface | null · readOnly

expireDatetime

string | null · readOnly

acceptedDatetime

string | null · readOnly

declinedDatetime

string | null · readOnly

POST/buddy-group-invitations/{buddyGroupInvitationId:\d+}/accept

curl 'https://api.cineamo.com/buddy-group-invitations/:buddyGroupInvitationId:\d+/accept' \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "buddyGroupId": 1,
  "issuerId": 1,
  "recipient": {
    "id": 123,
    "username": "i_am_batman",
    "firstName": "Frank",
    "lastName": "Pentangeli",
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/user-profile",
    "isActivated": true,
    "isDeleted": "true",
    "lastAccessTokenDatetime": "2022-04-11T04:11:22Z"
  },
  "expireDatetime": "2029-04-11T04:11:22Z",
  "acceptedDatetime": "2029-04-11T04:11:22Z",
  "declinedDatetime": "2029-04-11T04:11:22Z"
}'

Example Request Body

{
  "id": 1,
  "buddyGroupId": 1,
  "issuerId": 1,
  "recipient": {
    "id": 123,
    "username": "i_am_batman",
    "firstName": "Frank",
    "lastName": "Pentangeli",
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/user-profile",
    "isActivated": true,
    "isDeleted": "true",
    "lastAccessTokenDatetime": "2022-04-11T04:11:22Z"
  },
  "expireDatetime": "2029-04-11T04:11:22Z",
  "acceptedDatetime": "2029-04-11T04:11:22Z",
  "declinedDatetime": "2029-04-11T04:11:22Z"
}

json

Example Responses

{
  "id": 1,
  "buddyGroupId": 1,
  "issuerId": 1,
  "recipient": {
    "id": 123,
    "username": "i_am_batman",
    "firstName": "Frank",
    "lastName": "Pentangeli",
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/user-profile",
    "isActivated": true,
    "isDeleted": "true",
    "lastAccessTokenDatetime": "2022-04-11T04:11:22Z"
  },
  "expireDatetime": "2029-04-11T04:11:22Z",
  "acceptedDatetime": "2029-04-11T04:11:22Z",
  "declinedDatetime": "2029-04-11T04:11:22Z"
}

json

application/json

List buddy group invitations

GET

https://api.cineamo.com

/buddy-group-invitations

Returns a list of BuddyGroupInvitation objects.

List buddy group invitations › query Parameters

page

integer

perPage

integer

sort

string

order

string

query

string

buddyGroupIds

integer[]

issuerIds

integer[]

recipientIds

integer[]

states

string[]

List buddy group invitations › Responses

BuddyGroupInvitation list

BuddyGroupInvitation

id

integer · readOnly

buddyGroupId

integer | null · readOnly

issuerId

integer | null · readOnly

CinApi\User\Dto\UserDtoInterface | null · readOnly

expireDatetime

string | null · readOnly

acceptedDatetime

string | null · readOnly

declinedDatetime

string | null · readOnly

Create a buddy group invitation

POST

https://api.cineamo.com

/buddy-group-invitations

Creates a BuddyGroupInvitation. It returns the BuddyGroupInvitation object.

Create a buddy group invitation › Request Body

BuddyGroupInvitation

id

integer · readOnly

buddyGroupId

integer | null · readOnly

issuerId

integer | null · readOnly

CinApi\User\Dto\UserDtoInterface | null · readOnly

expireDatetime

string | null · readOnly

acceptedDatetime

string | null · readOnly

declinedDatetime

string | null · readOnly

Create a buddy group invitation › Responses

BuddyGroupInvitation was created

BuddyGroupInvitation

id

integer · readOnly

buddyGroupId

integer | null · readOnly

issuerId

integer | null · readOnly

CinApi\User\Dto\UserDtoInterface | null · readOnly

expireDatetime

string | null · readOnly

acceptedDatetime

string | null · readOnly

declinedDatetime

string | null · readOnly

POST/buddy-group-invitations

curl https://api.cineamo.com/buddy-group-invitations \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "buddyGroupId": 1,
  "issuerId": 1,
  "recipient": {
    "id": 123,
    "username": "i_am_batman",
    "firstName": "Frank",
    "lastName": "Pentangeli",
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/user-profile",
    "isActivated": true,
    "isDeleted": "true",
    "lastAccessTokenDatetime": "2022-04-11T04:11:22Z"
  },
  "expireDatetime": "2029-04-11T04:11:22Z",
  "acceptedDatetime": "2029-04-11T04:11:22Z",
  "declinedDatetime": "2029-04-11T04:11:22Z"
}'

Example Request Body

{
  "id": 1,
  "buddyGroupId": 1,
  "issuerId": 1,
  "recipient": {
    "id": 123,
    "username": "i_am_batman",
    "firstName": "Frank",
    "lastName": "Pentangeli",
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/user-profile",
    "isActivated": true,
    "isDeleted": "true",
    "lastAccessTokenDatetime": "2022-04-11T04:11:22Z"
  },
  "expireDatetime": "2029-04-11T04:11:22Z",
  "acceptedDatetime": "2029-04-11T04:11:22Z",
  "declinedDatetime": "2029-04-11T04:11:22Z"
}

json

Example Responses

{
  "id": 1,
  "buddyGroupId": 1,
  "issuerId": 1,
  "recipient": {
    "id": 123,
    "username": "i_am_batman",
    "firstName": "Frank",
    "lastName": "Pentangeli",
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/user-profile",
    "isActivated": true,
    "isDeleted": "true",
    "lastAccessTokenDatetime": "2022-04-11T04:11:22Z"
  },
  "expireDatetime": "2029-04-11T04:11:22Z",
  "acceptedDatetime": "2029-04-11T04:11:22Z",
  "declinedDatetime": "2029-04-11T04:11:22Z"
}

json

application/json

Decline buddy group invitation

POST

https://api.cineamo.com

/buddy-group-invitations/{buddyGroupInvitationId:\d+}/decline

Declines a buddy group membership. It returns the BuddyGroupInvitation object.

Decline buddy group invitation › path Parameters

buddyGroupInvitationId

integer · required

Decline buddy group invitation › Request Body

BuddyGroupInvitation

id

integer · readOnly

buddyGroupId

integer | null · readOnly

issuerId

integer | null · readOnly

CinApi\User\Dto\UserDtoInterface | null · readOnly

expireDatetime

string | null · readOnly

acceptedDatetime

string | null · readOnly

declinedDatetime

string | null · readOnly

Decline buddy group invitation › Responses

200

BuddyGroupInvitation was declined

BuddyGroupInvitation

id

integer · readOnly

buddyGroupId

integer | null · readOnly

issuerId

integer | null · readOnly

CinApi\User\Dto\UserDtoInterface | null · readOnly

expireDatetime

string | null · readOnly

acceptedDatetime

string | null · readOnly

declinedDatetime

string | null · readOnly

POST/buddy-group-invitations/{buddyGroupInvitationId:\d+}/decline

curl 'https://api.cineamo.com/buddy-group-invitations/:buddyGroupInvitationId:\d+/decline' \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "buddyGroupId": 1,
  "issuerId": 1,
  "recipient": {
    "id": 123,
    "username": "i_am_batman",
    "firstName": "Frank",
    "lastName": "Pentangeli",
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/user-profile",
    "isActivated": true,
    "isDeleted": "true",
    "lastAccessTokenDatetime": "2022-04-11T04:11:22Z"
  },
  "expireDatetime": "2029-04-11T04:11:22Z",
  "acceptedDatetime": "2029-04-11T04:11:22Z",
  "declinedDatetime": "2029-04-11T04:11:22Z"
}'

Example Request Body

{
  "id": 1,
  "buddyGroupId": 1,
  "issuerId": 1,
  "recipient": {
    "id": 123,
    "username": "i_am_batman",
    "firstName": "Frank",
    "lastName": "Pentangeli",
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/user-profile",
    "isActivated": true,
    "isDeleted": "true",
    "lastAccessTokenDatetime": "2022-04-11T04:11:22Z"
  },
  "expireDatetime": "2029-04-11T04:11:22Z",
  "acceptedDatetime": "2029-04-11T04:11:22Z",
  "declinedDatetime": "2029-04-11T04:11:22Z"
}

json

Example Responses

{
  "id": 1,
  "buddyGroupId": 1,
  "issuerId": 1,
  "recipient": {
    "id": 123,
    "username": "i_am_batman",
    "firstName": "Frank",
    "lastName": "Pentangeli",
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/user-profile",
    "isActivated": true,
    "isDeleted": "true",
    "lastAccessTokenDatetime": "2022-04-11T04:11:22Z"
  },
  "expireDatetime": "2029-04-11T04:11:22Z",
  "acceptedDatetime": "2029-04-11T04:11:22Z",
  "declinedDatetime": "2029-04-11T04:11:22Z"
}

json

application/json

Get a buddy group invitation

GET

https://api.cineamo.com

/buddy-group-invitations/{buddyGroupInvitationId}

Returns a BuddyGroupInvitation object by its Id.

Get a buddy group invitation › path Parameters

buddyGroupInvitationId

string · required

Get a buddy group invitation › Responses

BuddyGroupInvitation details

BuddyGroupInvitation

id

integer · readOnly

buddyGroupId

integer | null · readOnly

issuerId

integer | null · readOnly

CinApi\User\Dto\UserDtoInterface | null · readOnly

expireDatetime

string | null · readOnly

acceptedDatetime

string | null · readOnly

declinedDatetime

string | null · readOnly

GET/buddy-group-invitations/{buddyGroupInvitationId}

curl https://api.cineamo.com/buddy-group-invitations/:buddyGroupInvitationId

Example Responses

{
  "id": 1,
  "buddyGroupId": 1,
  "issuerId": 1,
  "recipient": {
    "id": 123,
    "username": "i_am_batman",
    "firstName": "Frank",
    "lastName": "Pentangeli",
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/user-profile",
    "isActivated": true,
    "isDeleted": "true",
    "lastAccessTokenDatetime": "2022-04-11T04:11:22Z"
  },
  "expireDatetime": "2029-04-11T04:11:22Z",
  "acceptedDatetime": "2029-04-11T04:11:22Z",
  "declinedDatetime": "2029-04-11T04:11:22Z"
}

json

application/json

Delete a buddy group invitation

DELETE

https://api.cineamo.com

/buddy-group-invitations/{buddyGroupInvitationId}

Deletes a BuddyGroupInvitation. It returns an empty response.

Delete a buddy group invitation › path Parameters

buddyGroupInvitationId

string · required

Delete a buddy group invitation › Responses

BuddyGroupInvitation was deleted

No data returned

Update a buddy group invitation

PATCH

https://api.cineamo.com

/buddy-group-invitations/{buddyGroupInvitationId}

Updates a BuddyGroupInvitation. It returns the updated BuddyGroupInvitation object.

Update a buddy group invitation › path Parameters

buddyGroupInvitationId

string · required

Update a buddy group invitation › Request Body

BuddyGroupInvitation

id

integer · readOnly

buddyGroupId

integer | null · readOnly

issuerId

integer | null · readOnly

CinApi\User\Dto\UserDtoInterface | null · readOnly

expireDatetime

string | null · readOnly

acceptedDatetime

string | null · readOnly

declinedDatetime

string | null · readOnly

Update a buddy group invitation › Responses

BuddyGroupInvitation was updated

BuddyGroupInvitation

id

integer · readOnly

buddyGroupId

integer | null · readOnly

issuerId

integer | null · readOnly

CinApi\User\Dto\UserDtoInterface | null · readOnly

expireDatetime

string | null · readOnly

acceptedDatetime

string | null · readOnly

declinedDatetime

string | null · readOnly

PATCH/buddy-group-invitations/{buddyGroupInvitationId}

curl https://api.cineamo.com/buddy-group-invitations/:buddyGroupInvitationId \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --data '{
  "id": 1,
  "buddyGroupId": 1,
  "issuerId": 1,
  "recipient": {
    "id": 123,
    "username": "i_am_batman",
    "firstName": "Frank",
    "lastName": "Pentangeli",
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/user-profile",
    "isActivated": true,
    "isDeleted": "true",
    "lastAccessTokenDatetime": "2022-04-11T04:11:22Z"
  },
  "expireDatetime": "2029-04-11T04:11:22Z",
  "acceptedDatetime": "2029-04-11T04:11:22Z",
  "declinedDatetime": "2029-04-11T04:11:22Z"
}'

Example Request Body

{
  "id": 1,
  "buddyGroupId": 1,
  "issuerId": 1,
  "recipient": {
    "id": 123,
    "username": "i_am_batman",
    "firstName": "Frank",
    "lastName": "Pentangeli",
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/user-profile",
    "isActivated": true,
    "isDeleted": "true",
    "lastAccessTokenDatetime": "2022-04-11T04:11:22Z"
  },
  "expireDatetime": "2029-04-11T04:11:22Z",
  "acceptedDatetime": "2029-04-11T04:11:22Z",
  "declinedDatetime": "2029-04-11T04:11:22Z"
}

json

Example Responses

{
  "id": 1,
  "buddyGroupId": 1,
  "issuerId": 1,
  "recipient": {
    "id": 123,
    "username": "i_am_batman",
    "firstName": "Frank",
    "lastName": "Pentangeli",
    "profileImageRef": "00000000-0000-0000-0000-000000000000",
    "profileImageUrl": "https://cdn.example.com/00000000-0000-0000-0000-000000000000/user-profile",
    "isActivated": true,
    "isDeleted": "true",
    "lastAccessTokenDatetime": "2022-04-11T04:11:22Z"
  },
  "expireDatetime": "2029-04-11T04:11:22Z",
  "acceptedDatetime": "2029-04-11T04:11:22Z",
  "declinedDatetime": "2029-04-11T04:11:22Z"
}

json

application/json

Time Slots Comments