GET
/
applications
List applications
curl --request GET \
  --url https://api.synctera.com/v1/applications \
  --header 'Authorization: Bearer <token>'
{
  "applications": [
    {
      "application_details": {
        "sections": [
          {
            "fintech_section_id": "<string>",
            "pages": [
              {
                "fintech_page_id": "<string>",
                "items": [
                  "<any>"
                ],
                "title": "<string>"
              }
            ],
            "title": "<string>"
          }
        ]
      },
      "business_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "customer_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "description": "<string>",
      "status": "APPROVED",
      "type": "CREDIT",
      "creation_time": "2023-11-07T05:31:56Z",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "last_updated_time": "2023-11-07T05:31:56Z"
    }
  ],
  "next_page_token": "a8937a0d"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
customer_id
string<uuid>[]

A list of customer unique identifiers, with a comma separating any values.

Customer ID for the application

​
type
enum<string>

Type of application

Available options:
CREDIT,
RESTRICTED_ACCOUNT
Example:

"CREDIT"

​
page_token
string

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

Example:

"a8937a0d"

​
limit
integer
default:100

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

Required range: x >= 1
Example:

100

​
sort_by
enum<string>[]

Specifies the sort order for the returned applications.

​
status
enum<string>

Application status values for all types of applications

Available options:
APPROVED,
CREDIT_ACCEPTED_BY_CUSTOMER,
CREDIT_APPROVED,
CREDIT_DENIED,
CREDIT_NOT_ACCEPTED_BY_CUSTOMER,
DENIED,
IN_PROGRESS,
REVIEW_INFO_REQUESTED,
REVIEW_ON_SYNCTERA,
SUBMITTED
​
business_id
string<uuid>[]

A list of business unique identifiers, with a comma separating any values. Returns applications that are linked to the specified Business IDs.

Business ID for the application. An application must have either a Business or a customer associated with it.

Response

List of applications.

​
applications
(Restricted account application details · object | Credit application details · object)[]
required

Array of applications.

​
next_page_token
string

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

Example:

"a8937a0d"