Get Contact

GET /contacts/{contact_ref}

Returns a canonical contact identified by contact reference.

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/{contact_ref}" \
  -H "Authorization: Bearer {token}"

Request

Request Path

contact_ref

Public contact reference.

stringrequired

Responses

200 OK

Contact representation.

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

data

objectrequired

data.contact

Canonical contact resource.

objectrequired

data.contact.avatar_url

stringnullrequired

data.contact.email

string (email)required

data.contact.family_name

stringnullrequired

data.contact.given_name

stringrequired

data.contact.name

stringrequired

data.contact.notes

stringnullrequired

data.contact.organization

stringnullrequired

data.contact.phone

stringnullrequired

data.contact.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

404 Not Found

{
  "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