Devices

get

ViewSet for managing user devices.

Authorizations
Query parameters
limitintegerOptional

Number of results to return per page.

offsetintegerOptional

The initial index from which to return the results.

Responses
200Success
application/json
get
GET /api/users/devices HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Accept: */*
200Success
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "device_id": "text",
      "user": {
        "id": "text",
        "email": "text",
        "phone": "text",
        "profile": "text",
        "additional_user_fields": "text"
      },
      "created_at": "2025-07-23T12:22:54.510Z"
    }
  ]
}
post

ViewSet for managing user devices.

Authorizations
Body
idstring · uuidRead-onlyRequired
device_idstring · max: 255Required
user_idstring · uuidWrite-onlyRequired
userall ofRead-onlyRequired
created_atstring · date-time | nullableOptional
Responses
201Success
application/json
post
POST /api/users/devices HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 109

{
  "device_id": "text",
  "user_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-07-23T12:22:54.510Z"
}
201Success
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "device_id": "text",
  "user": {
    "id": "text",
    "email": "text",
    "phone": "text",
    "profile": "text",
    "additional_user_fields": "text"
  },
  "created_at": "2025-07-23T12:22:54.510Z"
}
get

ViewSet for managing user devices.

Authorizations
Path parameters
idstring · uuidRequired

A UUID string identifying this user device.

Responses
200Success
application/json
get
GET /api/users/devices/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Accept: */*
200Success
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "device_id": "text",
  "user": {
    "id": "text",
    "email": "text",
    "phone": "text",
    "profile": "text",
    "additional_user_fields": "text"
  },
  "created_at": "2025-07-23T12:22:54.510Z"
}
put

ViewSet for managing user devices.

Authorizations
Path parameters
idstring · uuidRequired

A UUID string identifying this user device.

Body
idstring · uuidRead-onlyRequired
device_idstring · max: 255Required
user_idstring · uuidWrite-onlyRequired
userall ofRead-onlyRequired
created_atstring · date-time | nullableOptional
Responses
200Success
application/json
put
PUT /api/users/devices/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 109

{
  "device_id": "text",
  "user_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-07-23T12:22:54.510Z"
}
200Success
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "device_id": "text",
  "user": {
    "id": "text",
    "email": "text",
    "phone": "text",
    "profile": "text",
    "additional_user_fields": "text"
  },
  "created_at": "2025-07-23T12:22:54.510Z"
}
delete

ViewSet for managing user devices.

Authorizations
Path parameters
idstring · uuidRequired

A UUID string identifying this user device.

Responses
204
No response body
delete
DELETE /api/users/devices/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Accept: */*
204

No response body

No content

patch

ViewSet for managing user devices.

Authorizations
Path parameters
idstring · uuidRequired

A UUID string identifying this user device.

Body
idstring · uuidRead-onlyOptional
device_idstring · max: 255Optional
user_idstring · uuidWrite-onlyOptional
userall ofRead-onlyOptional
created_atstring · date-time | nullableOptional
Responses
200Success
application/json
patch
PATCH /api/users/devices/{id} HTTP/1.1
Host: prosper-api-test.churchpad.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 109

{
  "device_id": "text",
  "user_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-07-23T12:22:54.510Z"
}
200Success
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "device_id": "text",
  "user": {
    "id": "text",
    "email": "text",
    "phone": "text",
    "profile": "text",
    "additional_user_fields": "text"
  },
  "created_at": "2025-07-23T12:22:54.510Z"
}