Lista e klienteve (v1) — fature.al API

GET /api/v1/clients Requires authentication Rate limited by the `api-global` limiter v1

Send a bearer token in the Authorization header.

Merr listen e klienteve te kompanise me faqosje dhe filtrim me tekst.

Faqezohet me limit dhe offset. limit kufizohet ne 100 dhe pagination kthen edhe total, prandaj e dini qe ne faqen e pare sa faqe ju presin: vazhdoni me offset += limit derisa offset te kaloje total.

Full URL: https://fature.al/api/v1/clients

Query parameters

Name	Type	Required	Description
limit	integer	no	Numri i klienteve per faqe (max 100). Defaults to `20`.
offset	integer	no	Nga cili klient te fillohet. Defaults to `0`.
query	string	no	Kerkim ne emer, mbiemer, NIPT, dokument, email ose telefon.

Responses

200 OK

Field	Type	Description
status	boolean
data	object
data.items	array
data.items[].id	integer
data.items[].name	string
data.items[].client_type	string, nullable
data.items[].company_name	string, nullable
data.items[].company_type	string, nullable
data.items[].nipt	string, nullable
data.items[].first_name	string, nullable
data.items[].surname	string, nullable
data.items[].birthday	string, nullable
data.items[].id_type	string, nullable
data.items[].id_num	string, nullable
data.items[].nationality_code	string, nullable
data.items[].nationality_id	integer, nullable
data.items[].telephone	string, nullable
data.items[].email	string, nullable
data.items[].address	string, nullable
data.items[].city	string, nullable
data.items[].customer_number	string, nullable
data.items[].created_at	string, nullable
data.pagination	object
data.pagination.records	integer
data.pagination.total	integer
data.pagination.limit	integer
data.pagination.offset	integer

429 Kufiri i kerkesave u arrit. Kufiri per endpoint kthen zarfin standard te gabimit; kufiri i pergjithshem kthen vetem `message` bashke me header-in `Retry-After`.

Field	Type	Description
status	boolean	Always false. A successful response carries `status: true` and a `data` object instead
message	string	The exception message. Empty when the failure carries no exception of its own
errors	array	Messages to show the operator or to log. Absent when the failure has nothing to add beyond `message`

500 Gabim i papritur ne server.

Field	Type	Description
status	boolean	Always false. A successful response carries `status: true` and a `data` object instead
message	string	The exception message. Empty when the failure carries no exception of its own
errors	array	Messages to show the operator or to log. Absent when the failure has nothing to add beyond `message`

Example request

cURL

curl -X GET 'https://fature.al/api/v1/clients' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'X-Client-Id: YOUR_CLIENT_ID' \
  -H 'X-Client-Secret: YOUR_CLIENT_SECRET' \
  -H 'Accept: application/json'

PHP (Laravel)

use Illuminate\Support\Facades\Http;

$response = Http::withHeaders([
    'Authorization' => 'Bearer YOUR_TOKEN',
    'X-Client-Id' => 'YOUR_CLIENT_ID',
    'X-Client-Secret' => 'YOUR_CLIENT_SECRET',
    'Accept' => 'application/json',
])->get('https://fature.al/api/v1/clients');

$data = $response->json();

PHP (Guzzle)

use GuzzleHttp\Client;

$client = new Client();

$response = $client->request('GET', 'https://fature.al/api/v1/clients', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_TOKEN',
        'X-Client-Id' => 'YOUR_CLIENT_ID',
        'X-Client-Secret' => 'YOUR_CLIENT_SECRET',
        'Accept' => 'application/json',
    ],
]);

$data = json_decode((string) $response->getBody(), true);

JavaScript

const response = await fetch('https://fature.al/api/v1/clients', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
    'X-Client-Id': 'YOUR_CLIENT_ID',
    'X-Client-Secret': 'YOUR_CLIENT_SECRET',
    'Accept': 'application/json'
  }
});

const data = await response.json();

Example response

200

{
    "status": true,
    "data": {
        "items": [
            {
                "id": 1,
                "name": "Jane Doe",
                "client_type": "client type",
                "company_name": "Jane Doe",
                "company_type": "company type",
                "nipt": "nipt",
                "first_name": "Jane",
                "surname": "Jane Doe",
                "birthday": "birthday",
                "id_type": "id type",
                "id_num": "id num",
                "nationality_code": "nationality code",
                "nationality_id": 1,
                "telephone": "+15551234567",
                "email": "[email protected]",
                "address": "1 Example Street",
                "city": "Berlin",
                "customer_number": "customer number",
                "created_at": "created at"
            }
        ],
        "pagination": {
            "records": 1,
            "total": 4200,
            "limit": 25,
            "offset": 0
        }
    }
}

429

{
    "status": true,
    "message": "Hello there",
    "errors": [
        "errors"
    ]
}

500

{
    "status": true,
    "message": "Hello there",
    "errors": [
        "errors"
    ]
}