Skip to main content
GET
/
credit-applications
Error
A valid request URL is required to generate request examples
{
  "items": [
    {
      "id": "<string>",
      "organization": {
        "id": "<string>",
        "name": "<string>",
        "email": "jsmith@example.com"
      },
      "credit_application_type": "credit_terms",
      "status": "pending",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "expires_at": "2023-11-07T05:31:56Z",
      "amount": 123,
      "currency": "<string>",
      "payment_terms": "<string>",
      "security_compliance": "<string>",
      "extra_details": {
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "proposed_amount": 1073741823,
        "proposed_terms": "<string>"
      }
    }
  ],
  "total_items": 1
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
Requester-Organization-ID
string<uuid>
required

The unique identifier of the organization making the request. This ID is used to authorize the requester within the system.

​
Target-Organization-ID
string<uuid>
required

The unique identifier of the organization that is the target of the request. The Target-Organization-ID may match the Requester-Organization-ID if the requester accesses their own resources. If the Target-Organization-ID differs from the Requester-Organization-ID, the requester can access third-party resources if the requester has a connection with the target organization and is authorized to perform such actions.

Query Parameters

​
shipper_id
string<uuid> | null
​
forwarder_id
string<uuid> | null
​
credit_application_types
enum<string>[] | null
Minimum array length: 1
Available options:
credit_terms,
trade_finance,
factoring
​
credit_application_statuses
enum<string>[] | null
Minimum array length: 1
Available options:
pending,
internal_review,
external_review,
needs_action,
approved,
finalized,
declined,
rejected,
expired
​
search_field
string
default:organization_name
Allowed value: "organization_name"
​
search_text
string | null
Required string length: 1 - 255
​
order_by
enum<string>
default:organization_name
Available options:
organization_id,
organization_name,
organization_email,
credit_application_type,
created_at,
updated_at,
amount,
payment_terms,
status,
extra_details_updated_at,
extra_details_created_at
​
order_dir
enum<string>
default:asc
Available options:
asc,
desc
​
limit
integer
required
Required range: x <= 100
​
offset
integer
required
Required range: x >= 0

Response

Successful Response

​
items
CreditApplicationListItem · object[]
required
​
total_items
integer
required
Required range: x >= 0