GET/api/v1/clients

Product availabilityAlgaPSAAlgaDesk

List clients

Inherited ApiBaseController list route for clients. Requires API-key auth and client:read permission.

RBAC · client

Query parameters

pagestringOptional

limitstringOptional

sortstringOptional

orderstringOptional

searchstringOptional

created_fromstring <date-time>Optional

created_tostring <date-time>Optional

updated_fromstring <date-time>Optional

updated_tostring <date-time>Optional

client_namestringOptional

emailstringOptional

client_typestringOptional

billing_cyclestringOptional

is_inactivestringOptional

is_tax_exemptstringOptional

account_manager_idstring <uuid>Optional

region_codestringOptional

credit_balance_minstringOptional

credit_balance_maxstringOptional

has_credit_limitstringOptional

industrystringOptional

company_sizestringOptional

Response body

Success response 200 · schema PaginatedClientEnvelope

dataarray of objectRequired

itemsobject

client_idstring <uuid>Required

client_namestringRequired

phone_nostringRequiredNullable

credit_balancenumberRequired

emailstringRequiredNullable

urlstringRequiredNullable

addressstringRequiredNullable

created_atstring <date-time>Required

updated_atstring <date-time>Required

is_inactivebooleanRequired

client_typestringRequiredNullable

tax_id_numberstringRequiredNullable

notesstringRequiredNullable

propertiesobject

industrystring

company_sizestring

annual_revenuestring

primary_contact_idstring <uuid>

primary_contact_namestring

statusstring

typestring

billing_addressstring

tax_idstring

notesstring

payment_termsstring

websitestring <uri>

parent_client_idstring <uuid>

parent_client_namestring

last_contact_datestring <date-time>

logostring

payment_termsstringRequiredNullable

billing_cyclestringRequired

Enum: weeklybi-weeklymonthlyquarterlysemi-annuallyannually

credit_limitnumberRequiredNullable

preferred_payment_methodstringRequiredNullable

auto_invoicebooleanRequired

invoice_delivery_methodstringRequiredNullable

region_codestringRequiredNullable

is_tax_exemptbooleanRequired

tax_exemption_certificatestringRequiredNullable

timezonestringRequiredNullable

invoice_template_idstring <uuid>RequiredNullable

billing_contact_idstring <uuid>RequiredNullable

billing_emailstringRequiredNullable

account_manager_idstring <uuid>RequiredNullable

account_manager_full_namestringNullable

logoUrlstringNullable

tenantstring <uuid>Required

tagsarray of string

itemsstring

paginationobjectRequired

pageintegerRequired

limitintegerRequired

totalintegerRequired

totalPagesintegerRequired

hasNextbooleanRequired

hasPrevbooleanRequired

metaobject

Response codes

200

Paginated clients returned.

400

Invalid query parameters.

401

API key missing/invalid or key user not found.

403

Permission denied for client read.

500

Unexpected client listing failure.

GET /api/v1/clients

cURL

curl -X GET "https://algapsa.com/api/v1/clients?page=string&limit=string&sort=string&order=asc&search=string&created_from=2026-04-18T15%3A22%3A14Z" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/v1/clients?page=string&limit=string&sort=string&order=asc&search=string&created_from=2026-04-18T15%3A22%3A14Z", {
  method: "GET",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
  }
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://algapsa.com/api/v1/clients?page=string&limit=string&sort=string&order=asc&search=string&created_from=2026-04-18T15%3A22%3A14Z");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": [
    {
      "client_id": "01HN2K7VRB9PQ3Y0000000000",
      "client_name": "string",
      "phone_no": "string",
      "credit_balance": 0,
      "email": "string",
      "url": "string",
      "address": "string",
      "created_at": "2026-04-18T15:22:14Z",
      "updated_at": "2026-04-18T15:22:14Z",
      "is_inactive": false,
      "client_type": "string",
      "tax_id_number": "string",
      "notes": "string",
      "properties": {
        "industry": "string",
        "company_size": "string",
        "annual_revenue": "string",
        "primary_contact_id": "01HN2K7VRB9PQ3Y0000000000",
        "primary_contact_name": "string",
        "status": "string",
        "type": "string",
        "billing_address": "string",
        "tax_id": "string",
        "notes": "string",
        "payment_terms": "string",
        "website": "https://example.com",
        "parent_client_id": "01HN2K7VRB9PQ3Y0000000000",
        "parent_client_name": "string",
        "last_contact_date": "2026-04-18T15:22:14Z",
        "logo": "string"
      },
      "payment_terms": "string",
      "billing_cycle": "weekly",
      "credit_limit": 0,
      "preferred_payment_method": "string",
      "auto_invoice": false,
      "invoice_delivery_method": "string",
      "region_code": "string",
      "is_tax_exempt": false,
      "tax_exemption_certificate": "string",
      "timezone": "string",
      "invoice_template_id": "01HN2K7VRB9PQ3Y0000000000",
      "billing_contact_id": "01HN2K7VRB9PQ3Y0000000000",
      "billing_email": "string",
      "account_manager_id": "01HN2K7VRB9PQ3Y0000000000",
      "account_manager_full_name": "string",
      "logoUrl": "string",
      "tenant": "01HN2K7VRB9PQ3Y0000000000",
      "tags": [
        "string"
      ]
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 1,
    "total": 1,
    "totalPages": 1,
    "hasNext": false,
    "hasPrev": false
  },
  "meta": {}
}