sam|nord Developers
samnord.com
Events

GET /events/{id}

View a specific event. Requires events.read permission.

Path parameters

Name Type Required Description
id string yes The unique identifier of the record

Query parameters

Name Type Required Description
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, organization, site, order, exceptions, assignments.

Responses

Status Description
200 A json object describing the event
403 Forbidden
404 Not found

Response 200 body

  • data object · required
  • meta object · required
{
    "data": {
        "id": "string",
        "allDay": false,
        "confirmedAt": "string",
        "confirmedBy": {
            "id": "019222d9-d87d-7724-bba6-ba91503ea311",
            "firstName": "John",
            "lastName": "Doe"
        },
        "createdAt": "2024-06-30T19:00:00Z",
        "createdBy": {
            "id": "019222d9-d87d-7724-bba6-ba91503ea311",
            "firstName": "John",
            "lastName": "Doe"
        },
        "description": "string",
        "durationMinutes": 0,
        "orderId": "string",
        "organization": {
            "id": "019222d9-d87d-7724-bba6-ba91503ea311",
            "name": "ACME Corporation"
        },
        "recurring": false,
        "rrule": "string",
        "site": {
            "id": "019222d9-d87d-7724-bba6-ba91503ea311",
            "name": "Stockholm Office"
        },
        "start": "string",
        "status": "draft",
        "title": "string",
        "type": "scheduled_work",
        "until": "string",
        "updatedAt": "2024-06-30T19:00:00Z",
        "updatedBy": {
            "id": "019222d9-d87d-7724-bba6-ba91503ea311",
            "firstName": "John",
            "lastName": "Doe"
        }
    },
    "meta": {
        "requestId": "019a3a60-6328-7075-8a41-76ff545ca5d3",
        "userId": "019a3a60-929c-7820-9b35-bf79a8bf83a6",
        "organizationId": "019a3a60-8175-7a68-88da-ecb4a7040b86"
    }
}