Benefit Applicants

Retrieve Benefit Applicant

get

Retrieve a specific benefit applicant by its ID.

Authorizations

Token

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

Benefit applicant retrieved successfully.

application/json

401

Unauthorized Access

application/json

403

Forbidden

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

get

/api/v1/benefit_applicants/{id}/

HTTPcURLJavaScriptPython

GET /api/v1/benefit_applicants/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "pk": 1,
  "discount_item": 1,
  "order_item": 1,
  "discount_share": 1,
  "created_date": "2026-01-19T23:31:16.585Z",
  "modified_date": "2026-01-19T23:31:16.585Z"
}

List Benefit Applicants

get

Retrieve a paginated list of benefit applicants.

Authorizations

Token

AuthorizationstringRequired

Query parameters

pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1

limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10

pkintegerOptional

Filters by primary key

pk__gtstringOptional

Filter by primary key greater than a specific value.

pk__gteintegerOptional

Filters by primary key greater than or equal to the given value

pk__ltintegerOptional

Filters by primary key less than the given value

pk__lteintegerOptional

Filters by primary key less than or equal to the given value

discount_share__gtnumber · decimalOptional

Filter by discount share greater than this value.

discount_share__ltnumber · decimalOptional

Filter by discount share less than this value.

discount_share__gtenumber · decimalOptional

Filter by discount share greater than or equal to this value.

discount_share__ltenumber · decimalOptional

Filter by discount share less than or equal to this value.

order_item__ininteger[]Optional

Comma-separated list of order item IDs to filter by.

discount_itemintegerOptional

Filter by discount item ID

order_itemintegerOptional

Filter by order item ID.

created_datestring · date-timeOptional

Filter by creation date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).

Example: created_date__gt=2024-01-01T00:00:00Z

modified_datestring · date-timeOptional

Filter by modification date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).

Example: modified_date__lt=2024-01-01T00:00:00Z

Responses

200

A list of benefit applicants.

application/json

401

Unauthorized Access

application/json

403

Forbidden

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

get

/api/v1/benefit_applicants/

HTTPcURLJavaScriptPython

GET /api/v1/benefit_applicants/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 1,
  "next": "https://example.com",
  "previous": "https://example.com",
  "results": [
    {
      "created_date": "2026-01-19T23:31:16.585Z",
      "modified_date": "2026-01-19T23:31:16.585Z"
    }
  ]
}