GET/api/v1/contacts/search

Product availabilityAlgaPSAAlgaDesk

Search contacts

Runs advanced contact search with explicit API-key auth and contact:read permission check.

RBAC · contact

Query parameters

querystringRequired

fieldsstringOptional

Comma-separated field list; parsed by contactSearchSchema transform.

client_idstring <uuid>Optional

include_inactivestringOptional

limitstringOptional

Response body

Success response 200 · schema ContactSearchEnvelope

dataarray of ContactResourceRequired

itemsobject

contact_name_idstring <uuid>Required

full_namestringRequired

client_idstring <uuid>RequiredNullable

emailstring <email>Required

rolestringRequiredNullable

created_atstring <date-time>Required

updated_atstring <date-time>Required

is_inactivebooleanRequired

tenantstring <uuid>Required

phone_numbersarray of object

itemsobject

contact_phone_number_idstring <uuid>Required

phone_numberstringRequired

normalized_phone_numberstringRequired

canonical_typestringNullable

custom_phone_type_idstring <uuid>Nullable

custom_typestringRequiredNullable

is_defaultbooleanRequired

display_orderintegerRequired

≥ 0

additional_email_addressesarray of object

itemsobject

contact_additional_email_address_idstring <uuid>Required

email_addressstring <email>Required

normalized_email_addressstring <email>Required

canonical_typestringNullable

custom_email_type_idstring <uuid>Nullable

custom_typestringRequiredNullable

display_orderintegerRequired

≥ 0

default_phone_numberstringNullable

default_phone_typestringNullable

primary_email_canonical_typestringNullable

primary_email_custom_type_idstring <uuid>Nullable

primary_email_typestringNullable

notesstringNullable

avatarUrlstringNullable

tagsarray of string

itemsstring

client_namestringNullable

metaobject

Response codes

200

Contact search results returned.

400

Invalid search query.

401

API key missing/invalid or key user not found.

403

Permission denied for contact read.

500

Unexpected contact search failure.

GET /api/v1/contacts/search

cURL

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

TypeScript

const response = await fetch("https://algapsa.com/api/v1/contacts/search?query=x&fields=string&client_id=01HN2K7VRB9PQ3Y0000000000&include_inactive=true&limit=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/search?query=x&fields=string&client_id=01HN2K7VRB9PQ3Y0000000000&include_inactive=true&limit=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",
      "client_id": "01HN2K7VRB9PQ3Y0000000000",
      "email": "user@example.com",
      "role": "string",
      "created_at": "2026-04-18T15:22:14Z",
      "updated_at": "2026-04-18T15:22:14Z",
      "is_inactive": false,
      "tenant": "01HN2K7VRB9PQ3Y0000000000",
      "phone_numbers": [
        {
          "contact_phone_number_id": "01HN2K7VRB9PQ3Y0000000000",
          "phone_number": "string",
          "normalized_phone_number": "string",
          "canonical_type": "string",
          "custom_phone_type_id": "01HN2K7VRB9PQ3Y0000000000",
          "custom_type": "string",
          "is_default": false,
          "display_order": 0
        }
      ],
      "additional_email_addresses": [
        {
          "contact_additional_email_address_id": "01HN2K7VRB9PQ3Y0000000000",
          "email_address": "user@example.com",
          "normalized_email_address": "user@example.com",
          "canonical_type": "string",
          "custom_email_type_id": "01HN2K7VRB9PQ3Y0000000000",
          "custom_type": "string",
          "display_order": 0
        }
      ],
      "default_phone_number": "string",
      "default_phone_type": "string",
      "primary_email_canonical_type": "string",
      "primary_email_custom_type_id": "01HN2K7VRB9PQ3Y0000000000",
      "primary_email_type": "string",
      "notes": "string",
      "avatarUrl": "string",
      "tags": [
        "string"
      ],
      "client_name": "string"
    }
  ],
  "meta": {}
}