Skip to main content
Collection Partner API

Users

Base URL
https://collectionpartner-api.debitura.com
Authentication
API key in the XApiKey header

Lists team members belonging to the authenticated collection partner.

GET/users

Returns a paginated list of users belonging to the authenticated collection partner's team.

Use Case: Use this endpoint to retrieve valid user IDs for the assignedUserId field when activating a case via POST /cases/{id}/start.

Pagination:

  • page (default: 1) — Page number, starting from 1
  • pageSize (default: 50, max: 100) — Number of results per page

Response: Each user entry includes:

  • id (Guid) — Use this as assignedUserId in POST /cases/{id}/start
  • name — Full name of the team member
  • email — Email address of the team member

Query parameters

  • Pageinteger
  • PageSizeinteger

Returns

200 Paginated list of team members returned

  • pageobjectRequired

    Stable v1 pagination metadata shared by public list responses.

  • usersarray of objectsnullable

    A user belonging to the authenticated collection partner's team. Use the Id as the assignedUserId when starting a case via POST /cases/{id}/start.

Errors

400Invalid pagination parameters
401Missing or invalid API key
500Internal server error

See Error handling.

GET/users
curl https://collectionpartner-api.debitura.com/users \
  -H "XApiKey: $DEBITURA_API_KEY"
Response
{
  "page": {
    "totalResults": 42,
    "pageSize": 25,
    "currentPage": 1,
    "responseCount": 42,
    "totalPages": 1
  },
  "users": [
    {
      "id": "3f2b6c1e-8a4d-4b7f-9c2e-5d1a0b9e7f31",
      "name": "Muster GmbH",
      "email": "finance@example.com"
    }
  ]
}