Members

GET /v1/members

List members

members:read

Request exampleNo request body

curl

curl https://api.rieckflow.com/v1/members \
  -H "Authorization: Bearer $RIECK_API_KEY"

TypeScript

const svar = await rieck.request("GET", "/v1/members");

Response

{
  "data": {
    "userId": "9b2f1c1e-6b87-4d9b-91a0-47c8d72b8440",
    "email": "alex@acme.example",
    "name": "Alex Jensen",
    "role": "admin",
    "primary": true
  }
}

200 Success envelopeapplication/json

Response fields 3

Field	Type	Description
data.userId	uuid	Stable user id.
data.role	string	Role key accepted by the member update endpoint.
data.primary	boolean	Whether this is the organisation’s primary member.

Possible errors 4

HTTP	Code	Meaning
401	invalid_api_key	The API key is missing, invalid, expired or revoked.
403	api_not_included	The organisation’s plan does not include API access.
403	insufficient_scope	The key does not have the required scope.
429	rate_limited	The organisation’s rate budget is exhausted.

---

PATCH /v1/members/{userId}

Assign role

members:manage

The last admin is protected. Privilege-escalation surface — grant members:manage sparingly.

Parameter	In	Type	Required	Description
userId	path	string	Yes

Request body fields 1

Field	Type	Required	Description
role	string	Yes	Field in the request payload.

Request exampleapplication/json

curl

curl -X PATCH https://api.rieckflow.com/v1/members/9b2f1c1e-… \
  -H "Authorization: Bearer $RIECK_API_KEY" \
  -H "Idempotency-Key: order-2041" \
  -H "Content-Type: application/json" \
  -d '{
    "role": "admin"
  }'

TypeScript

const svar = await rieck.request("PATCH", "/v1/members/9b2f1c1e-…", {
  body: {
    "role": "admin"
  },
});

Response

{
  "data": {
    "userId": "9b2f1c1e-6b87-4d9b-91a0-47c8d72b8440",
    "email": "alex@acme.example",
    "name": "Alex Jensen",
    "role": "admin",
    "primary": true
  }
}

200 Success envelopeapplication/json

Response fields 3

Field	Type	Description
data.userId	uuid	Stable user id.
data.role	string	Role key accepted by the member update endpoint.
data.primary	boolean	Whether this is the organisation’s primary member.

Possible errors 9

HTTP	Code	Meaning
400	invalid_idempotency_key	Idempotency-Key is missing or malformed.
400	invalid_request	The request body or parameter failed validation.
401	invalid_api_key	The API key is missing, invalid, expired or revoked.
403	api_not_included	The organisation’s plan does not include API access.
403	insufficient_scope	The key does not have the required scope.
409	idempotency_conflict	The same key was used with a different request.
409	idempotency_in_progress	The same operation is currently being processed. Retry later.
413	payload_too_large	The JSON or uploaded file exceeds this endpoint’s size limit.
429	rate_limited	The organisation’s rate budget is exhausted.

Request body — fuldt JSON Schema

{
  "type": "object",
  "properties": {
    "role": {
      "type": "string",
      "minLength": 1,
      "maxLength": 60
    }
  },
  "required": [
    "role"
  ],
  "additionalProperties": false
}

---

GET /v1/roles

Role catalogue

members:read

Request exampleNo request body

curl

curl https://api.rieckflow.com/v1/roles \
  -H "Authorization: Bearer $RIECK_API_KEY"

TypeScript

const svar = await rieck.request("GET", "/v1/roles");

Response

{
  "data": [
    {
      "key": "admin",
      "builtin": true
    }
  ]
}

200 Success envelopeapplication/json

Possible errors 4

HTTP	Code	Meaning
401	invalid_api_key	The API key is missing, invalid, expired or revoked.
403	api_not_included	The organisation’s plan does not include API access.
403	insufficient_scope	The key does not have the required scope.
429	rate_limited	The organisation’s rate budget is exhausted.