Kullanıcı Listeleme

İlgili access_token'a ait kullanıcılar listelenir.

Endpoint

GET /kolaybi/v1/users

Parametreler

Bu endpoint herhangi bir parametre almaz.

Örnekler

cURL

curl -X GET "https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/users" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Channel: YOUR_CHANNEL"

JavaScript

async function listUsers() {
  const response = await fetch(
    "https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/users",
    {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        Channel: channel,
      },
    }
  );
  return await response.json();
}

// Kullanım
const users = await listUsers();

PHP

function listUsers() {
    $url = 'https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/users';

    $ch = curl_init();
    curl_setopt_array($ch, [
        CURLOPT_URL => $url,
        CURLOPT_HTTPHEADER => [
            'Authorization: Bearer ' . $accessToken,
            'Channel: ' . $channel
        ],
        CURLOPT_RETURNTRANSFER => true
    ]);

    $response = curl_exec($ch);
    curl_close($ch);
    return json_decode($response, true);
}

Python

import requests

def list_users():
    url = 'https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/users'
    headers = {
        'Authorization': f'Bearer {access_token}',
        'Channel': channel
    }

    response = requests.get(url, headers=headers)
    return response.json()

# Kullanım
users = list_users()

C#

using System;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Threading.Tasks;
using Newtonsoft.Json;

async Task<dynamic> ListUsersAsync()
{
    using var client = new HttpClient();

    var request = new HttpRequestMessage(HttpMethod.Get,
        "https://ofis-sandbox-api.kolaybi.com/kolaybi/v1/users");

    request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", accessToken);
    request.Headers.Add("Channel", channel);

    var response = await client.SendAsync(request);
    var content = await response.Content.ReadAsStringAsync();
    return JsonConvert.DeserializeObject<dynamic>(content);
}

// Kullanım
var users = await ListUsersAsync();

Yanıt

{
  "data": [
    {
      "id": 1,
      "email": "user@example.com",
      "name": "Ali",
      "surname": "Kara",
      "phone": "+905123456789"
    }
  ]
}

Yanıt Alanları

Alan	Tip	Açıklama
id	integer	Kullanıcıya ait ID değeri
email	string	Kullanıcının e-mail adresi
name	string	Kullanıcının adı
surname	string	Kullanıcının soyadı
phone	string	Kullanıcının telefon numarası