Bulk Apps Download API (Early Access)

BalkanID Apps Download CSV Format

In this section, we will explain the BalkanID Apps CSV format.

Sample CSV

Tenant ID	Tenant Name	Tenant Status	Tenant Created At	ID	Name	Description	Logo
01XB	default	active	2022-01-11	asana	Asana	Work management platform	https://logo_link/
01XB	default	active	2022-01-12	aws	Amazon Web Services	Cloud computing platform	https://logo_link/

Column Definitions

Column Name	Column Description
Tenant ID	Required, unique identifier for the tenant
Tenant Name	Required, name of the tenant
Tenant Status	Required, status of the tenant (e.g., active, inactive)
Tenant Created At	Required, date when the tenant was created
ID	Required, unique identifier
Name	Required, name
Description	Optional, description of the entity
Logo	Optional, URL link to the logo image

Download the CSV file via the pre-signed URL

After retrieving the pre-signed URL in the previous step, all that remains
is to download the CSV in
from the pre-signed URL.

To use the polling URL, first send an HTTP request with the method HEAD to
the pollingUrl.

If the response status code is 404, the file is not ready, and you should
retry this polling request after a delay.

If the response status code is 200, the file is ready, and you may proceed
to download the CSV from the received url.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

download url response

Body

Download URL endpoint response

pollingUrl

string

required

The value is the polling URL which you will use to poll to find if the data is ready for download.

url

string

required

The value is the download URL from which you will download your CSV file.

Example

{
    "pollingUrl": "string",
    "url": "string"
}

🔴500Server Error

Bulk Apps Download API (Early Access)

BalkanID Apps Download CSV Format#

Column Definitions#

Download the CSV file via the pre-signed URL#

Request

Request samples

Responses

BalkanID Apps Download CSV Format

Column Definitions

Download the CSV file via the pre-signed URL