sam|nord Developers
samnord.com
Coworkers

GET /coworkers

List coworkers in the current organization. Requires users.read 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[]=firstName) One of: authProvider, email, firstName, id, lastName, mfa, phoneNumber, roles, sites.
search string no Search by name or email
roleIds[] string (uuid)[] no Filter by role ID(s)
siteIds[] string (uuid)[] no Filter by site ID(s)
orderBy string no Field to order by One of: lastName, firstName, email, createdAt.
order string no Specifies in what direction the results should be ordered (ASC/DESC) One of: asc, desc.
count integer no Specifies the number of results to show per page of paginated results (1-500)
page integer no Specifies the page number of the results to show

Responses

Status Description
200 A paginated response of coworkers

Response 200 body

  • data object[] · required
  • links object · required
  • meta object · required
{
    "data": [
        {
            "id": "019222d4-1d93-7d47-a3c4-b547e009a0f7",
            "authProvider": "safesites",
            "email": "john.doe@example.com",
            "firstName": "John",
            "lastName": "Doe",
            "mfa": false,
            "phoneNumber": "+46701234567",
            "roles": [
                {
                    "id": "01930a94-6a1a-7834-b6c2-4fb5efb0988a",
                    "name": "Admin"
                }
            ],
            "sites": [
                {
                    "id": "019222d4-1d93-7d47-a3c4-b547e009a0f7",
                    "name": "Stockholm Office"
                }
            ]
        }
    ],
    "links": {
        "first": "https://api.safesites.app/sites?page=1",
        "last": "https://api.safesites.app/sites?page=10",
        "prev": null,
        "next": "https://api.safesites.app/sites?page=2"
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 10,
        "links": [
            {
                "url": "https://api.safesites.app/sites?page=2",
                "label": "Next",
                "active": true
            }
        ],
        "path": "https://api.safesites.app/sites",
        "per_page": 100,
        "to": 100,
        "total": 1000,
        "userId": "01930a9b-7b61-79a5-9ba2-78f0b4b2c196",
        "requestId": "01930a9b-8d1f-766f-945c-ef6408134dbc"
    }
}