users

Find multiple users.

GET

/getUsers

curl --request GET \
  --url 'https://api-sandbox.timeking.nl/api/external/v1/getUsers?select=%3Cstring%3E&group_by=%3Cstring%3E&order_by=%3Cstring%3E&offset=123&limit=123' \
  --header 'X-API-Key: <api-key>'

{
  "data": {
    "result": "<string>",
    "users": [
      {
        "activated_at": "2023-11-07T05:31:56Z",
        "activation_code": "<string>",
        "add_hours_mail": 123,
        "address": "<string>",
        "avatar_url": "<string>",
        "banned_at": "2023-11-07T05:31:56Z",
        "banned_reason": "<string>",
        "clock_type": "<string>",
        "contactperson": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "created_ip_address": "<string>",
        "custom_message": 123,
        "custom_message_history": "<string>",
        "date_of_birth": "2023-12-25",
        "default_administration_id": 123,
        "default_client_id": 123,
        "default_extrawork_id": 123,
        "default_operation_category_id": 123,
        "default_operation_id": 123,
        "default_order_id": 123,
        "default_task_type_slug": "<string>",
        "default_travel_time": 123,
        "default_user_group_id": 123,
        "default_vehicle2_id": 123,
        "default_vehicle3_id": 123,
        "default_vehicle_id": 123,
        "deleted_at": "2023-11-07T05:31:56Z",
        "deleted_by": 123,
        "description": "<string>",
        "dont_save_images_to_gallery": 123,
        "email": "<string>",
        "employee_number": "<string>",
        "extra_data": {},
        "first_name": "<string>",
        "groups": [
          {
            "code": "<string>",
            "color": "<string>",
            "description": "<string>",
            "id": 123,
            "name": "<string>",
            "pivot": {
              "user_group_id": 123,
              "user_id": 123
            },
            "sort_order": 123
          }
        ],
        "house_number": "<string>",
        "id": 123,
        "initials": "<string>",
        "is_guest": 123,
        "is_mail_blocked": 123,
        "is_support_active": 123,
        "keep_screen_active": 123,
        "language_preference": "<string>",
        "last_ip_address": "<string>",
        "last_name": "<string>",
        "last_seen": "2023-11-07T05:31:56Z",
        "location_administration": 123,
        "location_automatic": 123,
        "location_coordinates": "<string>",
        "location_lastseen": "2023-11-07T05:31:56Z",
        "location_whoiswhere": 123,
        "mails": {},
        "new_tasks_mail": 123,
        "note_entries": [
          {
            "date": "<string>",
            "description": "<string>",
            "title": "<string>"
          }
        ],
        "notes": "<string>",
        "notification_frequency": "<string>",

Autorisaties

X-API-Keystringheaderverplicht

Queryparameters

selectstringquery

Comma-separated list of columns to return. Example: select=id,name

whereobjectquery

Multiple key value items on WHERE to search. Example: where[field] = value and where[relation.field] = value

group_bystringquery

Column on which to group by.

order_bystringquery

Column on which to order by, use parameter alignment = desc to order descending.

offsetintegerquery

The number of items to skip before starting to collect the result set.

limitintegerquery

The number of items to return. Defaults to and is capped at 1000 items per request.

Antwoord

Successful operation.

dataobject

The result message and the result data.

child attributes tonen

statusstring

The result status, success.

Nog hulp nodig? Vraag het team