{ "opencollection": "1.0.0", "info": { "name": "WorkOS admin-portal organizations API", "version": "1.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "organizations", "type": "folder" }, "items": [ { "info": { "name": "List Organizations", "type": "http" }, "http": { "method": "GET", "url": "https://api.workos.com/organizations", "params": [ { "name": "before", "value": "", "type": "query", "description": "An object ID that defines your place in the list. When the ID is not present, you are at the end of the list. For example, if you make a list request and receive 100 objects, ending with `\"obj_123\"`, your subsequent call can include `before=\"obj_123\"` to fetch a new batch of objects before `\"obj_123\"`." }, { "name": "after", "value": "", "type": "query", "description": "An object ID that defines your place in the list. When the ID is not present, you are at the end of the list. For example, if you make a list request and receive 100 objects, ending with `\"obj_123\"`, your subsequent call can include `after=\"obj_123\"` to fetch a new batch of objects after `\"obj_123\"`." }, { "name": "limit", "value": "", "type": "query", "description": "Upper limit on the number of objects to return, between `1` and `100`." }, { "name": "order", "value": "", "type": "query", "description": "Order the results by the creation time. Supported values are `\"asc\"` (ascending), `\"desc\"` (descending), and `\"normal\"` (descending with reversed cursor semantics where `before` fetches older records and `after` fetches newer records). Defaults to descending." }, { "name": "domains", "value": "", "type": "query", "description": "The domains of an Organization. Any Organization with a matching domain will be returned." }, { "name": "search", "value": "", "type": "query", "description": "Searchable text for an Organization. Matches against the organization name." } ] }, "docs": "Get a list of all of your existing organizations matching the criteria specified." }, { "info": { "name": "Create an Organization", "type": "http" }, "http": { "method": "POST", "url": "https://api.workos.com/organizations", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new organization in the current environment." }, { "info": { "name": "Get an Organization by External ID", "type": "http" }, "http": { "method": "GET", "url": "https://api.workos.com/organizations/external_id/:external_id", "params": [ { "name": "external_id", "value": "", "type": "path", "description": "The external ID of the Organization." } ] }, "docs": "Get the details of an existing organization by an [external identifier](/authkit/metadata/external-identifiers)." }, { "info": { "name": "Get an Organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.workos.com/organizations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier of the Organization." } ] }, "docs": "Get the details of an existing organization." }, { "info": { "name": "Update an Organization", "type": "http" }, "http": { "method": "PUT", "url": "https://api.workos.com/organizations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier of the Organization." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an organization in the current environment." }, { "info": { "name": "Delete an Organization", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.workos.com/organizations/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier of the Organization." } ] }, "docs": "Permanently deletes an organization in the current environment. It cannot be undone." }, { "info": { "name": "Get Audit Log Configuration", "type": "http" }, "http": { "method": "GET", "url": "https://api.workos.com/organizations/:id/audit_log_configuration", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique identifier of the Organization." } ] }, "docs": "Get the unified view of audit log trail and stream configuration for an organization." } ] } ], "bundled": true }