GET/api/v1/contacts/export

Export contacts

Exports contacts as CSV or JSON using explicit API-key auth and contact:read permission.

RBAC · contact

Query parameters

formatstringOptional

include_inactivestringOptional

client_idstring <uuid>Optional

fieldsstringOptional

Array schema expects parsed list, but URL values arrive as string.

Response body

Success response 200 · schema ContactExportEnvelope

dataarray of ContactExportRowRequired

itemsobject

contact_name_idstring <uuid>Required

full_namestringRequired

emailstring <email>RequiredNullable

rolestringRequiredNullable

is_inactivebooleanRequired

created_atstring <date-time>Required

client_namestringRequiredNullable

default_phone_numberstringRequiredNullable

default_phone_typestringRequiredNullable

metaobject

Response codes

200

Contact export response. CSV format returns text/csv body; JSON format returns standard API envelope.

401

API key missing/invalid or key user not found.

403

Permission denied for contact read.

500

Unexpected contact export failure.

GET /api/v1/contacts/export

cURL

curl -X GET "https://algapsa.com/api/v1/contacts/export?format=csv&include_inactive=true&client_id=01HN2K7VRB9PQ3Y0000000000&fields=string" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/v1/contacts/export?format=csv&include_inactive=true&client_id=01HN2K7VRB9PQ3Y0000000000&fields=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/contacts/export?format=csv&include_inactive=true&client_id=01HN2K7VRB9PQ3Y0000000000&fields=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": [
    {
      "contact_name_id": "01HN2K7VRB9PQ3Y0000000000",
      "full_name": "string",
      "email": "user@example.com",
      "role": "string",
      "is_inactive": false,
      "created_at": "2026-04-18T15:22:14Z",
      "client_name": "string",
      "default_phone_number": "string",
      "default_phone_type": "string"
    }
  ],
  "meta": {}
}