bulk-uploads
Download CSV template for a domain
GET
/v1/bulk-uploads/template
const url = 'https://aggregator.example.com/v1/bulk-uploads/template';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://aggregator.example.com/v1/bulk-uploads/template \ --header 'Authorization: Bearer <token>'Returns a CSV template (text/csv) with the header row + sample row for the requested ?participant_type= (seeker/provider). Array-typed fields use the network’s csv_array_delimiter. Responds with a text/csv attachment on 200 (no JSON body).
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”participant_type
string
Participant domain id declared by the active network (e.g. seeker, provider).
Responses
Section titled “Responses”Default Response
Media typeapplication/json
object
error
required
object
code
required
string
title
required
string
detail
required
string
docs
string
fields
object
key
additional properties
requestId
required
string
timestamp
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{ "error": { "code": "example", "title": "example", "detail": "example", "docs": "example", "fields": { "additionalProperty": "example" }, "requestId": "example", "timestamp": "example" }}Default Response
Media typeapplication/json
object
error
required
object
code
required
string
title
required
string
detail
required
string
docs
string
fields
object
key
additional properties
requestId
required
string
timestamp
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{ "error": { "code": "example", "title": "example", "detail": "example", "docs": "example", "fields": { "additionalProperty": "example" }, "requestId": "example", "timestamp": "example" }}Default Response
Media typeapplication/json
object
error
required
object
code
required
string
title
required
string
detail
required
string
docs
string
fields
object
key
additional properties
requestId
required
string
timestamp
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{ "error": { "code": "example", "title": "example", "detail": "example", "docs": "example", "fields": { "additionalProperty": "example" }, "requestId": "example", "timestamp": "example" }}Default Response
Media typeapplication/json
object
error
required
object
code
required
string
title
required
string
detail
required
string
docs
string
fields
object
key
additional properties
requestId
required
string
timestamp
required
string
key
additional properties
any
key
additional properties
any
Examplegenerated
{ "error": { "code": "example", "title": "example", "detail": "example", "docs": "example", "fields": { "additionalProperty": "example" }, "requestId": "example", "timestamp": "example" }}
