Brein API

DeviceToken

Get all device tokens with pagination

GET

/api/v1/device-token

Retrieve a paginated list of device tokens based on query parameters

Get all device tokens with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size

Get all device tokens with pagination › Responses

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

GET /api/v1/device-token

curl --request GET \
  --url /api/v1/device-token

shell

Show example in

Example Responses

No example

json

application/json

Register a device token

POST

/api/v1/device-token

Register a device token › Request Body

tokenstring · required
Firebase Token Device
platformstring · required
Platform of the device

Register a device token › Responses

No data returned

POST /api/v1/device-token

curl --request POST \
  --url /api/v1/device-token \
  --header 'Content-Type: application/json' \
  --data '
{
  "token": "token",
  "platform": "platform"
}
'

shell

Show example in

Request Body Example

{
  "token": "token",
  "platform": "platform"
}

json

Example Responses

No example

plain

Get device token by ID

GET

/api/v1/device-token/{id}

Retrieve a specific device token by its ID

Get device token by ID › path Parameters

idnumber · min: 1 · required
Id

Get device token by ID › Responses

DeviceToken detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
tokenstring · required
Firebase Token Device
platformstring · required
Platform of the device

GET /api/v1/device-token/{id}

curl --request GET \
  --url /api/v1/device-token/:id

shell

Show example in

Example Responses

No example

json

application/json

Update a device token

PUT

/api/v1/device-token/{id}

Update an existing device token by its ID

Update a device token › path Parameters

idnumber · min: 1 · required
Id

Update a device token › Request Body

tokenstring
Firebase Token Device
platformstring
Platform of the device

Update a device token › Responses

DeviceToken updated

No data returned

PUT /api/v1/device-token/{id}

curl --request PUT \
  --url /api/v1/device-token/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "token": "token",
  "platform": "platform"
}
'

shell

Show example in

Request Body Example

{
  "token": "token",
  "platform": "platform"
}

json

Example Responses

No example

plain

Delete a device token

DELETE

/api/v1/device-token/{id}

Delete a device token by its ID

Delete a device token › path Parameters

idnumber · min: 1 · required
Id

Delete a device token › Responses

DeviceToken deleted

No data returned

DELETE /api/v1/device-token/{id}

curl --request DELETE \
  --url /api/v1/device-token/:id

shell

Show example in

Example Responses

No example

plain

Family Delegates

Brein API

DeviceToken

Get all device tokens with pagination

GET

/api/v1/device-token

Retrieve a paginated list of device tokens based on query parameters

Get all device tokens with pagination › query Parameters

pagenumber
Current page
pageSizenumber
Page size

Get all device tokens with pagination › Responses

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

GET /api/v1/device-token

curl --request GET \
  --url /api/v1/device-token

shell

Show example in

Example Responses

No example

json

application/json

Register a device token

POST

/api/v1/device-token

Register a device token › Request Body

tokenstring · required
Firebase Token Device
platformstring · required
Platform of the device

Register a device token › Responses

No data returned

POST /api/v1/device-token

curl --request POST \
  --url /api/v1/device-token \
  --header 'Content-Type: application/json' \
  --data '
{
  "token": "token",
  "platform": "platform"
}
'

shell

Show example in

Request Body Example

{
  "token": "token",
  "platform": "platform"
}

json

Example Responses

No example

plain

Get device token by ID

GET

/api/v1/device-token/{id}

Retrieve a specific device token by its ID

Get device token by ID › path Parameters

idnumber · min: 1 · required
Id

Get device token by ID › Responses

DeviceToken detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
tokenstring · required
Firebase Token Device
platformstring · required
Platform of the device

GET /api/v1/device-token/{id}

curl --request GET \
  --url /api/v1/device-token/:id

shell

Show example in

Example Responses

No example

json

application/json

Update a device token

PUT

/api/v1/device-token/{id}

Update an existing device token by its ID

Update a device token › path Parameters

idnumber · min: 1 · required
Id

Update a device token › Request Body

tokenstring
Firebase Token Device
platformstring
Platform of the device

Update a device token › Responses

DeviceToken updated

No data returned

PUT /api/v1/device-token/{id}

curl --request PUT \
  --url /api/v1/device-token/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "token": "token",
  "platform": "platform"
}
'

shell

Show example in

Request Body Example

{
  "token": "token",
  "platform": "platform"
}

json

Example Responses

No example

plain

Delete a device token

DELETE

/api/v1/device-token/{id}

Delete a device token by its ID

Delete a device token › path Parameters

idnumber · min: 1 · required
Id

Delete a device token › Responses

DeviceToken deleted

No data returned

DELETE /api/v1/device-token/{id}

curl --request DELETE \
  --url /api/v1/device-token/:id

shell

Show example in

Example Responses

No example

plain

Family Delegates