Title: createOrganizationInvitationBulk return type does not match Backend API response shape · Issue #8740 · clerk/javascript · GitHub
Open Graph Title: createOrganizationInvitationBulk return type does not match Backend API response shape · Issue #8740 · clerk/javascript
X Title: createOrganizationInvitationBulk return type does not match Backend API response shape · Issue #8740 · clerk/javascript
Description: Package + version @clerk/backend@3.5.0 Description clerkClient.organizations.createOrganizationInvitationBulk() is typed as returning Promise
Open Graph Description: Package + version @clerk/backend@3.5.0 Description clerkClient.organizations.createOrganizationInvitationBulk() is typed as returning Promise
X Description: Package + version @clerk/backend@3.5.0 Description clerkClient.organizations.createOrganizationInvitationBulk() is typed as returning Promise<OrganizationInvitation[]>, but the Backend API en...
Opengraph URL: https://github.com/clerk/javascript/issues/8740
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"createOrganizationInvitationBulk return type does not match Backend API response shape","articleBody":"### Package + version\n\n`@clerk/backend@3.5.0`\n\n### Description\n\n`clerkClient.organizations.createOrganizationInvitationBulk()` is typed as returning `Promise\u003cOrganizationInvitation[]>`, but the Backend API endpoint it wraps returns an object with a `data` array and `total_count`.\n\nThe latest published declaration in `@clerk/backend@3.5.0` still has:\n\n```ts\ncreateOrganizationInvitationBulk(\n organizationId: string,\n params: CreateBulkOrganizationInvitationParams,\n): Promise\u003cOrganizationInvitation[]>;\n```\n\nThe compiled implementation appears to return the raw request result without unwrapping `data`:\n\n```js\nasync createOrganizationInvitationBulk(organizationId, params) {\n this.requireId(organizationId);\n return this.request({\n method: \"POST\",\n path: joinPaths(basePath19, organizationId, \"invitations\", \"bulk\"),\n bodyParams: params\n });\n}\n```\n\nHowever, the Backend API reference for `POST /v1/organizations/{organization_id}/invitations/bulk` shows a response shaped like:\n\n```json\n{\n \"data\": [\n {\n \"object\": \"organization_invitation\",\n \"id\": \"string\"\n }\n ],\n \"total_count\": 1\n}\n```\n\nDocs reference: https://clerk.com/docs/reference/backend-api/tag/organization-invitations/POST/organizations/%7Borganization_id%7D/invitations/bulk\n\nSDK reference currently says `Promise\u003cOrganizationInvitation[]>`: https://clerk.com/docs/reference/backend/organization/create-organization-invitation-bulk\n\n### Expected behavior\n\nEither:\n\n1. the SDK should unwrap and return `OrganizationInvitation[]`, matching the current TypeScript declaration, or\n2. the TypeScript declaration and SDK docs should reflect the actual returned object shape, likely something like `Promise\u003cPaginatedResourceResponse\u003cOrganizationInvitation[]>>` or `{ data: OrganizationInvitation[]; totalCount: number }`.\n\n### Actual behavior\n\nRuntime returns an object with a `data` array, while TypeScript says the method returns an array.\n\nThis makes code like this type-check but fail at runtime:\n\n```ts\nconst invitations = await clerkClient.organizations.createOrganizationInvitationBulk(orgId, params);\n\nfor (const invitation of invitations) {\n // invitations is not iterable if the runtime response is { data: [...] }\n}\n```\n\n### Workaround\n\n```ts\nconst response = await clerkClient.organizations.createOrganizationInvitationBulk(orgId, params) as\n | OrganizationInvitation[]\n | { data: OrganizationInvitation[]; totalCount?: number; total_count?: number };\n\nconst invitations = Array.isArray(response) ? response : response.data;\n```\n\n### Notes\n\nThe response shape shown in the Backend API reference is also consistent with other list-style Clerk responses that expose `data` and count metadata.","author":{"url":"https://github.com/MisterJimson","@type":"Person","name":"MisterJimson"},"datePublished":"2026-06-03T18:25:53Z","url":"https://github.com/clerk/javascript/issues/8740"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react-reconciler,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@d5750093facf |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:b23ffed3-103d-0b4a-02b3-fa86346ad990 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | C354:71C2F:11C432D:185B46C:6AFB6C9A |
| html-safe-nonce | 34a2c59aa04c8e107b89a3777eb29d64fc97767281d258418da03d58548f02a2 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJDMzU0OjcxQzJGOjExQzQzMkQ6MTg1QjQ2Qzo2QUZCNkM5QSIsInZpc2l0b3JfaWQiOiIxNDExNDcyMzc4NjM3ODA2NzQ2IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | 8f1e7f70ebef99f39cb83a395ac2f0c2c1bbc01ab98b59a4f0e78754272c1961 |
| hovercard-subject-tag | issue:4582568370 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/clerk/javascript/8740/issue_layout |
| twitter:image | https://opengraph.githubassets.com/86b0893436cf3a7971daa010be6b054e75d8955fc99d749a140d59c646ddd4dd/clerk/javascript/issues/8740 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/86b0893436cf3a7971daa010be6b054e75d8955fc99d749a140d59c646ddd4dd/clerk/javascript/issues/8740 |
| og:image:alt | Package + version @clerk/backend@3.5.0 Description clerkClient.organizations.createOrganizationInvitationBulk() is typed as returning Promise |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | MisterJimson |
| hostname | github.com |
| expected-hostname | github.com |
| None | cca289ecd54650fcf3c0b037a58b97186dee2cc4406819d87fab93728fd83700 |
| turbo-cache-control | no-preview |
| go-import | github.com/clerk/javascript git https://github.com/clerk/javascript.git |
| octolytics-dimension-user_id | 49538330 |
| octolytics-dimension-user_login | clerk |
| octolytics-dimension-repository_id | 438331492 |
| octolytics-dimension-repository_nwo | clerk/javascript |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 438331492 |
| octolytics-dimension-repository_network_root_nwo | clerk/javascript |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 88808b1fae5ab8a526a73e7ce5542a10eb9d6971 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width