Organizations

Organization management and membership

All endpoints require a bearer token (oh_... API key or user JWT) and are served under https://api.orderly-hub.com. Use the Try it consoles to run a request against the Preview (test) server.

Get current organization

GET/api/v1/organizations

Responses

200 Organization details

GET/api/v1/organizations

Get current organization

API key (Bearer token)

https://api-test.orderly-hub.com/api/v1/organizations

Update organization (admin only)

PATCH/api/v1/organizations

Request body

Field	Type	Description
name	string
settings	object

{
  "name": "Jane Doe",
  "settings": {}
}

Responses

200 Updated organization

PATCH/api/v1/organizations

Update organization (admin only)

API key (Bearer token)

Request body (JSON){ "name": "Jane Doe", "settings": {} }

https://api-test.orderly-hub.com/api/v1/organizations

List organization members

GET/api/v1/organizations/members

Responses

200 List of members

GET/api/v1/organizations/members

List organization members

API key (Bearer token)

https://api-test.orderly-hub.com/api/v1/organizations/members

List pending invitations

GET/api/v1/organizations/members/invitations

Responses

200 List of invitations

GET/api/v1/organizations/members/invitations

List pending invitations

API key (Bearer token)

https://api-test.orderly-hub.com/api/v1/organizations/members/invitations

Invite a member (admin only)

POST/api/v1/organizations/members/invite

Request body

Field	Type	Description
email	string
role	member | admin | owner

{
  "email": "jane@example.com",
  "role": "member"
}

Responses

201 Invitation created

POST/api/v1/organizations/members/invite

Invite a member (admin only)

API key (Bearer token)

Request body (JSON){ "email": "jane@example.com", "role": "member" }

https://api-test.orderly-hub.com/api/v1/organizations/members/invite

Cancel an invitation (admin only)

DELETE/api/v1/organizations/members/invite/{invitationId}

Parameters

Name	In	Required	Type	Description
invitationId	path	yes	string

Responses

200 Invitation cancelled

DELETE/api/v1/organizations/members/invite/{invitationId}

Cancel an invitation (admin only)

API key (Bearer token)

invitationId * (path)

https://api-test.orderly-hub.com/api/v1/organizations/members/invite/

Accept an invitation by token

POST/api/v1/organizations/members/invite/{token}/accept

Parameters

Name	In	Required	Type	Description
token	path	yes	string

Responses

200 Invitation accepted

POST/api/v1/organizations/members/invite/{token}/accept

Accept an invitation by token

API key (Bearer token)

token * (path)

Request body (JSON)

https://api-test.orderly-hub.com/api/v1/organizations/members/invite//accept

Remove a member (admin only)

DELETE/api/v1/organizations/members/{userId}

Parameters

Name	In	Required	Type	Description
userId	path	yes	string

Responses

200 Member removed

DELETE/api/v1/organizations/members/{userId}

Remove a member (admin only)

API key (Bearer token)

userId * (path)

https://api-test.orderly-hub.com/api/v1/organizations/members/