Get a contact

Returns a single contact, including its notes.

GET

https://app.touchsms.com.au/api/v2/contacts/{contact}

Authorization

basicAuth
HTTP
required

Path parameters

contact
integer
required
Contact ID.

Returns

200

The contact.

JSON

data
optional
object
- id
  optional
  integer
- user
  optional
  integer
  ID of the user that owns the contact.
- firstname
  optional
  string | null
- surname
  optional
  string | null
- email
  optional
  string | null
- number
  optional
  string
- metadata
  optional
  object | null
- groups
  optional
  array of
  object
  id
  optional
  integer
  name
  optional
  string
- notes
  optional
  array of
  object
  Notes on the contact. Only returned when getting or updating a single contact.
  
  id
  optional
  integer
  content
  optional
  string
  created_at
  optional
  string
  format: date-time
  updated_at
  optional
  string
  format: date-time
- updated
  optional
  string
  format: date-time
- created
  optional
  string
  format: date-time
}

401

Missing, malformed or invalid API credentials.

JSON

message
string
required

403

The resource exists but does not belong to you, or you lack permission.

JSON

message
string
required

404

The resource does not exist.

JSON

message
string
required

{ "data": { "id": 4040, "user": 5678, "firstname": "Sam", "surname": "Taylor", "email": "sam@example.com", "number": "+61412345678", "metadata": null, "groups": [ { "id": 512, "name": "Customers" } ], "updated": "2024-03-11T02:14:07Z", "created": "2024-02-02T23:51:19Z" } }