users.archived

Crewsum sends users.archived when a user is archived or restored.

Event type

users.archived

When it is sent

• Archiving or unarchiving a user in the Crewsum app.

Crewsum sends the event only after the change is saved. A request that fails or is rejected sends no event. See Delivery for timing and retries.

Payload

data.users is an array. Each item has the user and isArchived. isArchived is true when the user was archived and false when the user was restored.

{
  "event": "users.archived",
  "data": {
    "users": [
      {
        "user": {
          "userId": "acme#alex.rivera",
          "email": "alex.rivera@example.com",
          "displayName": "Alex Rivera",
          "systemRole": "assoc",
          "customFields": {
            "employeeNumber": "E-2041"
          },
          "supplierId": null,
          "startDate": "2026-01-05",
          "endDate": null,
          "createdAt": "2026-09-28T14:05:12.000Z",
          "updatedAt": "2026-09-30T09:41:27.000Z",
          "preferredTimezone": "America/Los_Angeles",
          "groups": [
            {
              "id": "group-abc123def4567890",
              "name": "Field Technicians",
              "description": "On-site installation crew",
              "userCount": 4,
              "createdAt": "2026-09-28T14:05:12.000Z",
              "updatedAt": "2026-09-28T14:05:12.000Z"
            }
          ]
        },
        "isArchived": true
      }
    ]
  }
}

Related API calls

The public API cannot archive users, so no API call sends this event. Use these endpoints to read the user’s current state.

Get User

Get Users