Coop
API Reference

Contacts

Create, list, update, delete, import, and export contacts.

POST /api/v1/contacts

Create a contact.

Request

FieldTypeRequiredDescription
firstNamestringYesFirst name
lastNamestringNoLast name
phoneNumbersstring[]NoPhone numbers in E.164 format
emailAddressesstring[]NoEmail addresses
appleIdstringNoApple ID if different from email
organizationstringNoCompany name
jobTitlestringNoJob title
tagsstring[]NoTags for filtering and grouping
notesstringNoFree-form notes

Response 201

The created contact object.


GET /api/v1/contacts

List contacts.

Query parameters

ParameterTypeDefaultDescription
searchstringSearch by name, phone, email, or tag
tagsstringComma-separated tag filter
pagenumber1Page number
limitnumber20Results per page

GET /api/v1/contacts/:id

Get a single contact.


PUT /api/v1/contacts/:id

Update a contact. Partial updates — only include fields you want to change.


DELETE /api/v1/contacts/:id

Delete a contact.


POST /api/v1/contacts/import

Bulk import contacts from a CSV or JSON file. Send as multipart/form-data.

Response 200

{
  "created": 45,
  "updated": 3,
  "failed": 2,
  "errors": [
    { "row": 12, "error": "Invalid phone number format" }
  ]
}

GET /api/v1/contacts/export

Export contacts as CSV or JSON.

Query parameters

ParameterTypeDefaultDescription
formatstringjsoncsv or json
searchstringSame filters as list endpoint
tagsstringSame filters as list endpoint

POST /api/v1/contact-groups

Create a contact group.

Request

FieldTypeRequiredDescription
namestringYesGroup name

GET /api/v1/contact-groups

List all contact groups.


POST /api/v1/contact-groups/:id/members

Add a contact to a group.

Request

FieldTypeRequiredDescription
contactIdstringYesContact ID to add

DELETE /api/v1/contact-groups/:id/members/:contactId

Remove a contact from a group.

On this page