List Contacts

GET /contacts

Returns a paginated canonical contact collection owned by the authenticated actor.

Conventions

Authentication

All endpoints require a Bearer token. Pass it in the Authorization header as Bearer <token>. Tokens are issued from the API settings page in your workspace.

Base URL

All paths are relative to https://api.allsign.app. The spec includes full paths; strip the base when constructing requests.

Versioning

The current version is 0.1.0. Breaking changes are documented in the Changelog and announced before taking effect.

Specification

The API follows OpenAPI Specification 3.x. All documentation on this page is generated directly from the spec.

Example

Bash

curl "https://api.allsign.app/contacts" \
  -H "Authorization: Bearer {token}"

Parameters

Query

page

One-based page number.

integer = 1optional

page_size

Maximum number of records returned per page.

integer = 20optional

search

Filters contacts by canonical searchable fields.

stringoptional

Responses

200 OK

Paginated contact list.

{
  "data": {
    "contacts": [
      {
        "avatar_url": "",
        "email": "",
        "family_name": "",
        "given_name": "",
        "name": "",
        "notes": "",
        "organization": "",
        "phone": "",
        "ref": "00000000-0000-4000-8000-000000000000"
      }
    ]
  }
}

data

Standard paginated collection metadata.

objectrequired

data.contacts

object[]required

data.contacts[].avatar_url

stringnullrequired

data.contacts[].email

string (email)required

data.contacts[].family_name

stringnullrequired

data.contacts[].given_name

stringrequired

data.contacts[].name

stringrequired

data.contacts[].notes

stringnullrequired

data.contacts[].organization

stringnullrequired

data.contacts[].phone

stringnullrequired

data.contacts[].ref

Public stable resource reference.

string (uuid)required

401 Unauthorized

{
  "error": {
    "code": "",
    "message": "",
    "request_id": "",
    "status": 1
  }
}

error

objectrequired

error.code

stringrequired

error.message

stringrequired

error.request_id

stringrequired

error.status

integerrequired

error.fields

object[]optional