Developer Hub
Request Demo
Request Demo
Support
  1. Entities
  • Getting Started
    • Introduction
  • API Reference
    • Admins
      • Bulk Admins Download API (Early Access)
    • Apps
      • Bulk Apps Download API (Early Access)
    • Business Owners
      • Bulk Business Owners Download API (Early Access)
      • Bulk Business Owners Upload API (Early Access)
    • Campaigns
      • Bulk Campaigns Download API (Early Access)
      • Bulk Campaigns Upload API (Early Access)
    • Configuration
      • Bulk Applied Labels Upload API (Early Access)
      • Bulk Entity Finding Rules Download API (Early Access)
      • Bulk Custom Insights (Entity Rules) Download API (Early Access)
      • Bulk Filters Download API (Early Access)
      • Bulk Filters Upload API (Early Access)
      • Bulk Findings Download API (Early Access)
      • Bulk Findings Upload API (Early Access)
      • Bulk Labels Download API (Early Access)
      • Bulk Labels Upload API (Early Access)
      • Bulk Privileged Download API (Early Access)
      • Bulk Privileged Upload API (Early Access)
      • Bulk RBAC Download API (Early Access)
      • Bulk RBAC Upload API (Early Access)
      • Bulk RBAC2 Download API (Early Access)
      • Bulk RBAC2 Upload API (Early Access)
      • Bulk Rules Download API (Early Access)
      • Bulk Rules Upload API (Early Access)
    • Employees
      • Bulk Employees Download API (Early Access)
      • Bulk Employees Upload API (Early Access)
    • Entitlements
      • Bulk Entitlements Download API (Early Access)
      • Bulk Entitlements Upload API (Early Access)
    • Entities
      • Bulk Entities Download API (Early Access)
        POST
      • Bulk Entities Upload API (Early Access)
        POST
    • EntityInsights
      • Bulk Entity Insights Download API (Early Access)
      • Bulk Entity Insights Upload API (Early Access)
    • EntityRelations
      • Bulk Entity Relations Download API (Early Access)
      • Bulk Entity Relations Upload API (Early Access)
    • EntityRBAC
      • Bulk Entity RBAC Download API
      • Bulk Entity RBAC Upload API
    • Integrations
      • Bulk Integrations Download API (Early Access)
      • Bulk Integrations Upload API (Early Access)
    • Purposes
      • Bulk Purposes Download API (Early Access)
      • Bulk Purposes Upload API (Early Access)
    • Relations
      • Bulk Relations Download API (Early Access)
      • Bulk Relations Upload API (Early Access)
    • Requests
      • Bulk Requests Download API (Early Access)
      • Bulk Requests Upload API (Early Access)
    • Reviews
      • Bulk Reviews Download API (Early Access)
      • Bulk Reviews Upload API (Early Access)
    • Playbooks
      • Bulk Playbook Templates Download API (Early Access)
      • Bulk Playbook Templates API (Early Access)
    • Webhooks
      • Bulk Webhook Templates Download API (Early Access)
      • Bulk Webhook Templates API (Early Access)
  • Playbooks
    • Overview
  1. Entities

Bulk Entities Download API (Early Access)

POST
https://app.balkan.id/api/rest/v0/entities/download-url

BalkanID Entities Download CSV Format#

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

Sample CSV#

BRN*Timestamp*App*Integration*Name*Entity Type*Source System*Source ID*Source Type*Metadata VersionMetadata
brn:bid:balkanid:::01HWBCYJA11R3AA48K5V0DVM00:identity:04giq7jlHzhHyZ-cOvAn4Fn2dNc3bjqZrK4ufzx19Q02024-04-27 06:33:31 +0000 UTCawsAaron Ellisidentityazure63c16f61-d355-420b-87c6-615785ad8053userv1{"username":"aaron.ellis@itadminbalkan.onmicrosoft.com","lastPasswordChange":"2023-12-14 04:39:56 +0000 UTC","userCreatedDateTime":"2023-12-14 04:39:56 +0000 UTC","jobTitle":"Media Consultant","department":"Media and Pulic Relations"}
brn:bid:balkanid:::01HWBCYJA11R3AA48K5V0DVM00:identity:04giq7jlHzhHyZ-cOvAn4Fn2dNc3bjqZrK4ufzx19Q02024-04-27 06:33:31 +0000 UTCawsAaron Comptonidentityazure63c16f61-d355-420b-87c6-615785ad8053userv1{"username":"aaron.compton@adminbalkan.onmicrosoft.com","lastPasswordChange":"2023-12-14 05:01:10 +0000 UTC","userCreatedDateTime":"2023-12-14 05:01:10 +0000 UTC","jobTitle":"Accountant","department":"Finance"}
brn:bid:balkanid:::01HWBCYJA11R3AA48K5V0DVM00:identity:04giq7jlHzhHyZ-cOvAn4Fn2dNc3bjqZrK4ufzx19Q02024-04-27 06:33:31 +0000 UTCawsAabbott Reeseidentityazure63c16f61-d355-420b-87c6-615785ad8053userv1{"username":"aabbott.reese@balkanit.onmicrosoft.com","lastPasswordChange":"2023-12-14 04:42:12 +0000 UTC","userCreatedDateTime":"2023-12-14 04:42:12 +0000 UTC","jobTitle":"Software Engineer","department":"Engineering"}
brn:bid:balkanid:::01HWBCYJA11R3AA48K5V0DVM00:identity:04giq7jlHzhHyZ-cOvAn4Fn2dNc3bjqZrK4ufzx19Q02024-04-27 06:33:31 +0000 UTCawsAaron Alvaradoidentityazure63c16f61-d355-420b-87c6-615785ad8053userv1{"username":"aaron.alvarado@itadminbalkan.onmicrosoft.com","lastPasswordChange":"2023-12-14 05:02:01 +0000 UTC","userCreatedDateTime":"2023-12-14 05:02:01 +0000 UTC","jobTitle":"Analyst","department":"Operations"}
Columns with * are required always.
Column Definitions#
Column NameColumn Description
BRNRequired - Balkan Resource Name
TimestampRequired - Timestamp of the entity
AppApplication the Entity is associated with
IntegrationRequired - Integration ID the entity is assoicated with
NameRequired - Name of the entity
Entity TypeRequired - The type of the entity
Source SystemRequired - Source System of the entity
Source IDRequired - ID of the source system
Source TypeRequired - Type of the source system
Metadata VersionVersion of the metadata, according to the metadata schema
MetadataMetadata for the entity
"Name", "Entity Type", "Source System", "Source ID", "Source Type" and required columns. If metadata is present, metadata version has to be specified.

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 BalkanID Entities CSV format 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

Header Params

Body Params application/json

Example
{
    "integrationID": "string"
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://app.balkan.id/api/rest/v0/entities/download-url' \
--header 'X-Api-Key-ID;' \
--header 'X-Api-Key-Secret;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "integrationID": "string"
}'

Responses

🟢200OK
application/json
download url response
Body

Example
{
    "pollingUrl": "string",
    "url": "string"
}
🔴500Server Error
Modified at 2025-04-10 03:44:22
Previous
Bulk Entitlements Upload API (Early Access)
Next
Bulk Entities Upload API (Early Access)
Built with