List client locations

Returns locations associated with client_id after client existence check.

RBAC · client

Path parameters

idstring <uuid>Required

Response body

Success response 200 · schema ClientLocationsEnvelope

dataarray of objectRequired

itemsobject

location_idstring <uuid>Required

client_idstring <uuid>Required

location_namestringRequiredNullable

address_line1stringRequired

address_line2stringRequiredNullable

address_line3stringRequiredNullable

citystringRequired

state_provincestringRequiredNullable

postal_codestringRequiredNullable

country_codestringRequired

country_namestringRequired

region_codestringRequiredNullable

is_billing_addressbooleanRequired

is_shipping_addressbooleanRequired

is_defaultbooleanRequired

phonestringRequiredNullable

faxstringRequiredNullable

emailstringRequiredNullable

notesstringRequiredNullable

is_activebooleanRequired

created_atstring <date-time>Required

updated_atstring <date-time>Required

tenantstring <uuid>Required

metaobject

Response codes

200

Client locations returned.

400

Invalid client id format.

401

API key missing/invalid or key user not found.

403

Permission denied for client read.

404

Client not found.

500

Unexpected client locations failure.

GET /api/v1/clients/{id}/locations

cURL

curl -X GET "https://algapsa.com/api/v1/clients/{id}/locations" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/v1/clients/{id}/locations", {
  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/{id}/locations");
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": [
    {
      "location_id": "01HN2K7VRB9PQ3Y0000000000",
      "client_id": "01HN2K7VRB9PQ3Y0000000000",
      "location_name": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_line3": "string",
      "city": "string",
      "state_province": "string",
      "postal_code": "string",
      "country_code": "string",
      "country_name": "string",
      "region_code": "string",
      "is_billing_address": false,
      "is_shipping_address": false,
      "is_default": false,
      "phone": "string",
      "fax": "string",
      "email": "string",
      "notes": "string",
      "is_active": false,
      "created_at": "2026-04-18T15:22:14Z",
      "updated_at": "2026-04-18T15:22:14Z",
      "tenant": "01HN2K7VRB9PQ3Y0000000000"
    }
  ],
  "meta": {}
}