List contacts

A person connected to gigs — client, family, planner, vendor. Identity only: the role a contact plays is a fact about the pairing and lives on gig_contacts, never here. No direct gig FK (lookup-drop; the junction is the one association).

Query Parameters

limit
Type: integer
min:
0
max:
200

Page size, 50 by default, 200 at most.
offset
Type: integer
min:
0

Records to skip.
sort
Type: string

Comma-separated fields; prefix with - for descending. Sortable: fullName, first, last, email, phone, pronouns, instagram, createdTime, lastEditedTime, id. Default: fullName.
fields
Type: string

Comma-separated subset of fields to return. id is always included.
filter[fullName]

Shorthand filter[fullName]=value means equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.
Type: string

Shorthand filter[fullName]=value means equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.
filter[first]

Shorthand filter[first]=value means equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.
Type: string

Shorthand filter[first]=value means equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.
filter[last]

Shorthand filter[last]=value means equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.
Type: string

Shorthand filter[last]=value means equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.
filter[email]

Shorthand filter[email]=value means equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.
Type: stringFormat: email

Shorthand filter[email]=value means equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.
filter[phone]

Shorthand filter[phone]=value means equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.
Type: string

Shorthand filter[phone]=value means equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.
filter[pronouns]

Shorthand filter[pronouns]=value means equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.
Type: string

Shorthand filter[pronouns]=value means equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.
filter[instagram]

Shorthand filter[instagram]=value means equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.
Type: string

Shorthand filter[instagram]=value means equals. Operators: equals, does_not_equal, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty.
filter[createdTime]

Shorthand filter[createdTime]=value means equals. Operators: equals, before, after, on_or_before, on_or_after, is_empty, is_not_empty.
Type: stringFormat: date-time

Shorthand filter[createdTime]=value means equals. Operators: equals, before, after, on_or_before, on_or_after, is_empty, is_not_empty.
filter[lastEditedTime]

Shorthand filter[lastEditedTime]=value means equals. Operators: equals, before, after, on_or_before, on_or_after, is_empty, is_not_empty.
Type: stringFormat: date-time

Shorthand filter[lastEditedTime]=value means equals. Operators: equals, before, after, on_or_before, on_or_after, is_empty, is_not_empty.

Responses

application/json
application/json
application/json
application/json

get/contacts

curl 'https://api.weddingoperatingsystems.com/api/v1/contacts?limit=50&offset=0&sort=fullName' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

Show Schema

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "fullName": null,
      "first": null,
      "last": null,
      "email": null,
      "phone": null,
      "pronouns": null,
      "instagram": null,
      "createdTime": "2026-09-30T11:22:55.097Z",
      "lastEditedTime": "2026-09-30T11:22:55.097Z"
    }
  ],
  "meta": {
    "total": 1,
    "limit": 1,
    "offset": 1
  }
}

A page of contacts.