Skip to Content
Passage PlatformAPI ReferenceOrg Management

Org Management

Manage orgs, members, and API keys. All endpoints require JWT authentication (OAuth access token).

Orgs

List orgs

GET /v1/orgs

Returns the orgs the authenticated user belongs to.

Response (200):

{ "orgs": [ { "id": "org_xxx", "name": "Acme Corp", "role": "admin", "createdAt": 1704067200000 } ] }

Create org

POST /v1/orgs

Creates a new org. The authenticated user becomes its admin.

FieldTypeRequiredDescription
namestringYesOrg display name

Response (201):

{ "id": "org_xxx", "name": "Acme Corp", "createdAt": 1704067200000 }

Update org

PATCH /v1/orgs/:orgId

Update org settings. Requires admin role.

FieldTypeRequiredDescription
namestringNoNew org name

Members

List members

GET /v1/orgs/:orgId/members

List all members of an org. Requires admin or member role.

Response (200):

{ "members": [ { "userId": "usr_xxx", "email": "[email protected]", "name": "Alice", "role": "admin", "joinedAt": 1704067200000 } ] }

Invite member

POST /v1/orgs/:orgId/members

Add a user to the org by email. Requires admin role. The user must already have a Passage account.

FieldTypeRequiredDescription
emailstringYesUser’s email address
rolestringNoadmin, member, or viewer (default: member)

Response (201): { "ok": true }

Update member role

PATCH /v1/orgs/:orgId/members/:userId

Change a member’s role. Requires admin role.

FieldTypeRequiredDescription
rolestringYesadmin, member, or viewer

Remove member

DELETE /v1/orgs/:orgId/members/:userId

Remove a member from the org. Requires admin role.


API Keys

List keys

GET /v1/orgs/:orgId/keys

List API keys for an org. Requires admin or member role.

Response (200):

{ "keys": [ { "id": "key_xxx", "keyPrefix": "psg_abc1234", "name": "Production", "createdAt": 1704067200000, "revokedAt": null, "expiresAt": null } ] }

Create key

POST /v1/orgs/:orgId/keys

Create a new API key. Requires admin role. The full key is only returned once.

FieldTypeRequiredDescription
namestringNoDisplay name for the key
expiresInintegerNoExpiry in seconds from now

Response (201):

{ "id": "key_xxx", "key": "psg_abc1234def5678...", "prefix": "psg_abc1234", "expiresAt": null }

Revoke key

DELETE /v1/orgs/:orgId/keys/:keyId

Revoke an API key. Requires admin role. Revoked keys immediately stop working.

Next steps

Last updated on