sam|nord Developers
samnord.com
Roles

POST /roles

Create a role. Requires roles.write permission.

Query parameters

Name Type Required Description
fields[] string[] no Select which fields to include in the response. When omitted, all fields are returned. When provided, only the specified fields are included. (e.g., ?fields[]=id&fields[]=name) One of: createdAt, description, id, name, permissions, updatedAt.
with[] string[] no Include related resources in the response. Pass multiple values as separate query parameters (e.g., ?with[]=createdBy&with[]=updatedBy). One of: createdBy, updatedBy, workTasks, workTasksCount.

Request body

Required.

application/json

  • description string
  • name string · required
  • permissions string[]
  • workTaskIds string (uuid)[]
{
    "description": "SAM compliance safety representative",
    "name": "Safety Representative",
    "permissions": [
        "sites.create",
        "sites.read"
    ],
    "workTaskIds": [
        "019222d4-1d93-7d47-a3c4-b547e009a0f7"
    ]
}

Responses

Status Description
201 A json object describing the newly created role
400 The request was rejected
403 The requesting user lacks appropriate permissions
422 Validation errors

Response 201 body

  • data object · required — When fields[] is not provided, all properties are returned. When fields[] is provided, only the requested properties are included.
  • meta object · required
{
    "data": {
        "id": "019222d4-1d93-7d47-a3c4-b547e009a0f7",
        "createdAt": "2024-01-15T10:30:00Z",
        "createdBy": {
            "id": "019222d9-d87d-7724-bba6-ba91503ea311",
            "firstName": "John",
            "lastName": "Doe"
        },
        "description": "SAM compliance safety representative",
        "name": "Safety Representative",
        "permissions": [
            "sites.create",
            "sites.read"
        ],
        "updatedAt": "2024-01-15T14:20:00Z",
        "updatedBy": {
            "id": "019222d9-d87d-7724-bba6-ba91503ea311",
            "firstName": "John",
            "lastName": "Doe"
        },
        "workTasks": [
            {
                "id": "string",
                "active": false,
                "name": "string"
            }
        ],
        "workTasksCount": 0
    },
    "meta": {
        "requestId": "019a3a60-6328-7075-8a41-76ff545ca5d3",
        "userId": "019a3a60-929c-7820-9b35-bf79a8bf83a6",
        "organizationId": "019a3a60-8175-7a68-88da-ecb4a7040b86"
    }
}