Skip to main content
POST
/
v1
/
organizations
Create Organization
curl --request POST \
  --url https://api.linqalpha.com/v1/organizations \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "id": "organization_001",
  "name": "Example Investment Fund",
  "s3_path": "s3://example-bucket/organization_001/"
}
'
{
  "organization_id": "123e4567-e89b-12d3-a456-426614174000",
  "error": null
}

Authorizations

​
X-API-KEY
string
header
required

Body

application/json
​
id
string
required

Your organization ID

Example:

"org_001"

​
name
string
required

Organization's name

Example:

"Example Investment Organization"

​
s3_path
string

S3 path for organization data (optional)

Example:

"s3://example-bucket/organization_001/"

Response

Organization created successfully

​
organization_id
string<uuid>
required

Organization's UUID

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
error
string | null

Error message if creation failed

Example:

null