Skip to Content
API ReferenceOrganizations

Organizations

Manage your organization settings and team members. All API requests are scoped to a single organization based on the authenticated user’s membership.

Get Current Organization

GET/api/organizations/current

Retrieve the current organization's details.

Any authenticated user

Returns the organization associated with the current authentication context, including settings, plan, and usage.

curl -X GET "https://api.orderly.dev/api/organizations/current" \ -H "Authorization: Bearer ord_sk_..."

Response

{ "data": { "id": "uuid", "name": "Acme Fulfillment", "slug": "acme-fulfillment", "plan": "pro", "settings": { "timezone": "America/New_York", "default_currency": "USD" }, "created_at": "2025-06-01T00:00:00Z" } }

Update Current Organization

PATCH/api/organizations/current

Update the current organization's settings.

Admin or Owner

Updates the organization’s name, settings, or other configurable properties. Only users with the Admin or Owner role can update the organization.

Request Body

FieldTypeDescription
namestringOrganization display name
settingsobjectOrganization-wide settings
curl -X PATCH "https://api.orderly.dev/api/organizations/current" \ -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..." \ -H "Content-Type: application/json" \ -d '{ "name": "Acme Fulfillment Inc.", "settings": { "timezone": "America/Los_Angeles" } }'

List Members

GET/api/organizations/current/members

List all members of the current organization.

Any authenticated user

Returns all users who are members of the current organization, including their roles and invite status.

curl -X GET "https://api.orderly.dev/api/organizations/current/members" \ -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..."

Response

{ "data": [ { "id": "uuid", "user_id": "uuid", "email": "jane@acme.com", "name": "Jane Doe", "role": "owner", "status": "active", "joined_at": "2025-06-01T00:00:00Z" }, { "id": "uuid", "user_id": "uuid", "email": "bob@acme.com", "name": "Bob Smith", "role": "member", "status": "active", "joined_at": "2025-07-15T00:00:00Z" } ] }

Invite Member

POST/api/organizations/current/members

Invite a new member to the organization.

Admin or Owner

Sends an invitation email to join the organization. The invitee will receive a link to accept the invitation and create an account if needed.

Request Body

FieldTypeRequiredDescription
emailstringYesEmail address to invite
rolestringYesRole to assign: member, admin
curl -X POST "https://api.orderly.dev/api/organizations/current/members" \ -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..." \ -H "Content-Type: application/json" \ -d '{ "email": "alice@acme.com", "role": "member" }'

Response

{ "data": { "id": "uuid", "email": "alice@acme.com", "role": "member", "status": "invited", "invited_at": "2026-01-15T10:30:00Z" } }