{ "opencollection": "1.0.0", "info": { "name": "API Reference subpackage_bulkSync subpackage_organization API", "version": "1.0.0" }, "items": [ { "info": { "name": "subpackage_organization", "type": "folder" }, "items": [ { "info": { "name": "Get Current Organization", "type": "http" }, "http": { "method": "GET", "url": "https://app.polytomic.com/api/organization", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Polytomic-Version", "value": "" } ] }, "docs": "Returns the organization the caller is authenticated against.\n\nThis endpoint is the safest way to discover the effective organization for a\nuser-scoped or organization-scoped credential. It does not let callers inspect\narbitrary organizations; it only returns the organization implied by the\ncredential that authenticated the request.\n\nIf you need to enumerate or look up organizations across a partner account, use\n[`GET /api/organizations`](../../api-reference/organization/list) or\n[`GET /api/orga" }, { "info": { "name": "Get Organizations", "type": "http" }, "http": { "method": "GET", "url": "https://app.polytomic.com/api/organizations", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Polytomic-Version", "value": "" } ] }, "docs": "Lists every organization accessible to the calling partner, with the partner's owner organization first.\n\nIn `2025-09-18`, this endpoint is partner-scoped rather than a general\n\"current caller visibility\" listing. The partner owner organization is returned\nfirst, followed by child organizations.\n\nThis ordering matters for partner workflows such as shared connections, where\nthe parent connection must live in the partner owner organization.\n\nIf you need only the organization implied by the current" }, { "info": { "name": "Create Organization", "type": "http" }, "http": { "method": "POST", "url": "https://app.polytomic.com/api/organizations", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Polytomic-Version", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new organization under the calling partner account, optionally configuring SSO or OIDC at creation time.\n\n> 🚧 Requires partner key\n>\n> This endpoint is only accessible using [partner keys](../../guides/obtaining-api-keys#partner-keys).\n\nSSO and OIDC settings supplied at creation time can be updated later via\n`PUT /api/organizations/{id}`." }, { "info": { "name": "Get Organization", "type": "http" }, "http": { "method": "GET", "url": "https://app.polytomic.com/api/organizations/:id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Polytomic-Version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier of the organization." } ] }, "docs": "Returns a single organization by ID.\n\n> 📘 Credential scope varies by endpoint and API version\n>\n> Organization endpoints do not all share the same credential requirements.\n> Check each endpoint's description for the caller scope that applies in that\n> API version." }, { "info": { "name": "Update Organization", "type": "http" }, "http": { "method": "PUT", "url": "https://app.polytomic.com/api/organizations/:id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Polytomic-Version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier of the organization to update." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an organization's name and SSO or OIDC configuration.\n\n> 🚧 Requires partner key\n>\n> This endpoint is only accessible using [partner keys](../../../guides/obtaining-api-keys#partner-keys).\n\n> 📘 SSO and OIDC configuration is replaced in full on each update. Include all\n> desired settings in the request body, not just the fields you want to change." }, { "info": { "name": "Delete Organization", "type": "http" }, "http": { "method": "DELETE", "url": "https://app.polytomic.com/api/organizations/:id", "headers": [ { "name": "Authorization", "value": "" }, { "name": "X-Polytomic-Version", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier of the organization." } ] }, "docs": "Deletes an organization.\n\nPartner callers cannot delete their own owner organization." } ] } ], "bundled": true }