Contacts

Create, read, update, and delete contacts. Manage tags and bulk imports.

GET/v1/contacts

Retrieve a paginated list of contacts. Supports filtering by search term and tag.

Query Parameters

Parameter	Type	Description
`page`	integer	Page number (default: 1)
`per_page`	integer	Results per page (default: 25, max: 100)
`search`	string	Search by name, email, or phone
`tag`	string	Filter by tag slug

bash

curl "https://api.oryn.com/v1/contacts?page=1&per_page=25&search=john" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

json

{
  "data": [
    {
      "id": "ct_abc123",
      "name": "John Doe",
      "phone": "+1234567890",
      "email": "john@example.com",
      "tags": ["vip", "newsletter"],
      "created_at": "2026-01-15T10:30:00Z"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total": 142
  }
}

POST/v1/contacts

Create a new contact.

bash

curl -X POST https://api.oryn.com/v1/contacts \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Jane Smith",
    "phone": "+1987654321",
    "email": "jane@example.com",
    "tags": ["lead"]
  }'

Response

json

{
  "id": "ct_def456",
  "name": "Jane Smith",
  "phone": "+1987654321",
  "email": "jane@example.com",
  "tags": ["lead"],
  "created_at": "2026-04-10T14:22:00Z"
}

GET/v1/contacts/{id}

Retrieve a single contact by ID.

bash

curl https://api.oryn.com/v1/contacts/ct_abc123 \
  -H "Authorization: Bearer YOUR_API_KEY"

PUT/v1/contacts/{id}

Update an existing contact.

bash

curl -X PUT https://api.oryn.com/v1/contacts/ct_abc123 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "John D.",
    "email": "johnd@example.com"
  }'

DELETE/v1/contacts/{id}

Delete a contact. This action is irreversible.

bash

curl -X DELETE https://api.oryn.com/v1/contacts/ct_abc123 \
  -H "Authorization: Bearer YOUR_API_KEY"

POST/v1/contacts/{id}/tags

Add one or more tags to a contact.

bash

curl -X POST https://api.oryn.com/v1/contacts/ct_abc123/tags \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "tags": ["vip", "priority"]
  }'