Reference / Invitations

Request to join an organization.

POST /v1/organizations/{id}/join-requests
Secret API key operationId: request_join

Authorization

Server-to-server. Send a secret key as a Bearer token plus the x-application-id header.

Path parameters

  • id string<uuid> required

    Organization id

Request body · required

  • user_id string<uuid> required uuid

Responses

201 Requested
{
  "data": {
    "created_at": "2026-01-15T09:30:00Z",
    "email": "string",
    "id": "018f3c4a-7b2e-7c1d-9e0a-1f2b3c4d5e6f",
    "organization_id": "018f3c4a-7b2e-7c1d-9e0a-1f2b3c4d5e6f",
    "status": "string",
    "user_id": "018f3c4a-7b2e-7c1d-9e0a-1f2b3c4d5e6f"
  },
  "error": {
    "code": "string",
    "message": "string"
  },
  "meta": {
    "timestamp": "string"
  },
  "success": false
}
404 Organization not found
409 A pending request already exists

Request

curl -X POST "http://localhost:8080/v1/organizations/018f3c4a-7b2e-7c1d-9e0a-1f2b3c4d5e6f/join-requests" \
  -H "Content-Type: application/json" \
  -d '{
  "user_id": "018f3c4a-7b2e-7c1d-9e0a-1f2b3c4d5e6f"
}'

Try it

live request
POST http://localhost:8080/v1/organizations/018f3c4a-7b2e-7c1d-9e0a-1f2b3c4d5e6f/join-requests

Path parameters

Request body

application/json