Export clients as Xero Contacts CSV

Generates a Xero Contacts import CSV from the tenant clients (optionally limited to clientIds). Returns a CSV file. Requires billing:manage.

RBAC · billing

Query parameters

clientIdsstringOptional

Comma-separated client UUIDs to limit the export.

Response body

Success response 200 · schema PublicV1Success

dataanyOfRequired

anyOf (option 1)object

anyOf (option 2)array of object

itemsobject

metaobject

Response codes

200

CSV file (text/csv attachment).

400

Invalid request.

401

API key missing/invalid.

403

Caller lacks the required permission.

500

Unexpected error.

GET /api/v1/accounting-exports/xero-csv/client-export

cURL

curl -X GET "https://algapsa.com/api/v1/accounting-exports/xero-csv/client-export?clientIds=string" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/v1/accounting-exports/xero-csv/client-export?clientIds=string", {
  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/accounting-exports/xero-csv/client-export?clientIds=string");
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": {},
  "meta": {}
}