ParameterTable
DomainTable displaying API parameters with location (path/query/header/cookie), type, required flag, and description.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
userId | path | string (uuid) | required | Unique identifier of the user |
page | query | integer | optional | Page number (1-based) |
pageSize | query | integer | optional | Results per page |
Authorization | header | string | required | Bearer token |
roledeprecated | query | string | optional | Filter by role admineditorviewer |
<ParameterTable parameters={[
{ parameterId: 'p1', name: 'userId', in: 'path', required: true, schema: { type: 'string', format: 'uuid' } },
{ parameterId: 'p2', name: 'page', in: 'query', schema: { type: 'integer', default: 1 } },
{ parameterId: 'p3', name: 'Authorization', in: 'header', required: true, schema: { type: 'string' } },
{ parameterId: 'p4', name: 'role', in: 'query', schema: { type: 'string', enum: ['admin','editor','viewer'] }, deprecated: true },
]} />| Name | In | Type | Required | Description |
|---|---|---|---|---|
orgId | path | string (uuid) | required | Organisation ID |
projectId | path | string (uuid) | required | Project ID |
<ParameterTable parameters={[
{ parameterId: 'pp1', name: 'orgId', in: 'path', required: true, schema: { type: 'string', format: 'uuid' } },
{ parameterId: 'pp2', name: 'projectId', in: 'path', required: true, schema: { type: 'string', format: 'uuid' } },
]} />