v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB

EDD

List EDD review schedules

Get paginated list of EDD review schedules

get/edd/review_schedules

Query parameters

next_reviewstring date

Example:2024-06-15

Filter by exact next review date

bank_idinteger

Example:6

Filter by bank ID

customer_type'BUSINESS' | 'PERSON'

The type of customer.

Filter by customer type

next_review_gtestring date

Example:2024-06-15

Filter by next review date greater than or equal to this date

partner_idinteger

Example:6

Filter by partner ID

page_tokenstring

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:a8937a0d

limitinteger

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Example:100

next_review_ltestring date

Example:2024-12-31

Filter by next review date less than or equal to this date

customer_idstring[]

Filter by customer ID. Multiple IDs can be provided as a comma-separated list.

Response

List of EDD review schedules

next_page_tokenstring

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

Example response

{
  "edd_review_schedules": [
    {
      "creation_time": "2010-05-06T12:23:34.321Z",
      "customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "last_updated_time": "2010-05-06T12:23:34.321Z",
      "next_review": "2025-06-15",
      "tenant": "abcdef_ghijkl"
    }
  ],
  "next_page_token": "a8937a0d"
}