For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inBook a demo
  • Getting started
    • Introduction
    • Obtaining API keys
    • Quickstart
    • Native clients
    • Concepts
    • Embedding authentication
    • Versioning
    • Idempotent requests
    • Events
  • Configuring your connections
    • CDC streaming from databases
  • Code examples
    • Bulk sync (ELT) from HubSpot to PostgreSQL
    • Bulk sync (ELT) from Salesforce to S3
    • Bulk sync (ELT) from Salesforce to Snowflake
    • Model sync (Reverse ETL) from MongoDB to Salesforce
  • API Reference
      • GETGet Organizations
      • POSTCreate Organization
      • GETGet Organization
      • DELRemove Organization
      • PATCHUpdate Organization
Logo
Log inBook a demo
API ReferenceOrganization

Create Organization

POST
https://app.polytomic.com/api/organizations
POST
/api/organizations
$curl -X POST https://app.polytomic.com/api/organizations \
>     -H "X-Polytomic-Version: X-Polytomic-Version" \
>     -H "Content-Type: application/json" \
>     -u "<username>:<password>" \
>     -d '{
>  "name": "My Organization"
>}'
1{
2  "data": {
3    "id": "string",
4    "issuer": "https://example.com",
5    "name": "My Organization",
6    "sso_domain": "example.com",
7    "sso_org_id": "123456"
8  }
9}
Creates a new organization under the calling partner account, optionally configuring SSO or OIDC at creation time. > 🚧 Requires partner key > > This endpoint is only accessible using [partner keys](../../guides/obtaining-api-keys#partner-keys). SSO and OIDC settings supplied at creation time can be updated later via `PATCH /api/organizations/{id}`.
Was this page helpful?
Previous

Get Organization

Next

Creates a new organization under the calling partner account, optionally configuring SSO or OIDC at creation time.

🚧 Requires partner key

This endpoint is only accessible using partner keys.

SSO and OIDC settings supplied at creation time can be updated later via PATCH /api/organizations/{id}.

Authentication

AuthorizationBasic

This is the Polytomic deployment key (on-premises only)

OR
AuthorizationBearer
This is the Polytomic API key

Headers

X-Polytomic-VersionstringRequired

Request

This endpoint expects an object.
namestringRequired

Human-readable name of the organization. Must be unique across the partner account.

client_idstringOptional
OIDC client ID issued by the identity provider.
client_secretstringOptional

OIDC client secret issued by the identity provider. Write-only; never returned in responses.

issuerstringOptional

OIDC issuer URL for organizations using OpenID Connect single sign-on.

sso_domainstringOptional

Email domain used to match users to this organization during SSO sign-in.

sso_org_idstringOptional

WorkOS organization identifier linking this organization to its SAML/SSO configuration.

Response

OK
dataobject

Errors

401
Unauthorized Error
409
Conflict Error
422
Unprocessable Entity Error
500
Internal Server Error