Skip Navigation
Log In Sign Up

List All Recipients

·

Retrieve a paginated list of all recipients with optional filtering.

Request

GET https://tupel.com/api/recipients/

Authentication

This endpoint requires basic authentication with your Organization ID and API Key.

Query Parameters

  • created_from timestamp Optional
    Filter recipients created on or after this timestamp. Format: ISO 8601 (e.g., 2023-01-01T00:00:00Z).

  • created_to timestamp Optional
    Filter recipients created on or before this timestamp. Format: ISO 8601 (e.g., 2023-12-31T23:59:59Z).

  • updated_from timestamp Optional
    Filter recipients updated on or after this timestamp. Format: ISO 8601 (e.g., 2023-01-01T00:00:00Z).

  • updated_to timestamp Optional
    Filter recipients updated on or before this timestamp. Format: ISO 8601 (e.g., 2023-12-31T23:59:59Z).

  • entity string Optional
    Filter recipients by entity UID. Only returns recipients associated with the specified entity.

  • currency string Optional
    Filter recipients by currency. Possible values: USD, EUR, GBP, or other accepted currency codes.

  • order_by string Optional
    Field to sort the results by. Prefix with - for descending order (e.g., -created_at).

  • page integer Optional
    Page number for pagination. Default: 1.

Notes

  • By default, all recipients are returned, sorted by creation date (newest first).
  • Use the filtering parameters to narrow down results for better performance with large datasets.
  • For date range filters, both the start and end parameters are inclusive.
  • This endpoint uses page-based pagination with 10 items per page.
  • For more information about working with paginated results, see the pagination documentation.
  • When preparing to create a loan, you can use this endpoint to find appropriate recipients based on entity and currency.
  • For security purposes, account numbers might be partially masked depending on your permissions.

Example Request

curl -X GET "https://tupel.com/api/recipients/" \
  -u <YOUR_ORG_ID>:<YOUR_API_KEY>

Response

A successful request returns a 200 OK status code and a paginated list of Recipients in the response body.

Response Format

The response follows Tupel's standard pagination format with these fields:

  • count integer
    Total number of recipients matching the filter criteria.

  • next string or null
    URL to fetch the next page of results, or null if this is the last page.

  • previous string or null
    URL to fetch the previous page of results, or null if this is the first page.

  • items array
    Array of Recipient objects, limited to 10 per page.

Error Responses

Code Description
401 Unauthorized - Authentication failed. Check your Organization ID and API Key.
403 Forbidden - Insufficient permissions to list recipients.
422 Unprocessable Entity - Invalid filter parameters provided.

Example Error Response

{
  "detail": [
    {
      "type": "value_error",
      "loc": ["query", "currency"],
      "msg": "Invalid currency value. Must be one of: USD, EUR, GBP."
    }
  ]
}