API Reference

contacts

Purpose

This group contains endpoints tagged together in the OpenAPI spec. Use the summaries below to understand what each endpoint does.

When to use

Prefer calling APIs from your backend to avoid exposing secrets.
Handle errors consistently and log request IDs for support.

Endpoints (6)

Click an endpoint to jump to its details.

List all contacts (optional filter for P2P)

post/contacts

Create a contact

delete/contacts/{id}

Delete a contact

get/contacts/{id}

Get one contact by ID

patch/contacts/{id}

Update a contact (partial)

post/contacts/bulk

Bulk-import contacts

get/contacts

List all contacts (optional filter for P2P)

Auth

No detailed description provided for this operation in the OpenAPI spec.

operationId: ContactsController_findAlltag: contactspermalink

post/contacts

Create a contact

Auth

No detailed description provided for this operation in the OpenAPI spec.

operationId: ContactsController_createtag: contactspermalink

delete/contacts/{id}

Delete a contact

Auth

No detailed description provided for this operation in the OpenAPI spec.

operationId: ContactsController_removetag: contactspermalink

get/contacts/{id}

Get one contact by ID

Auth

No detailed description provided for this operation in the OpenAPI spec.

operationId: ContactsController_findOnetag: contactspermalink

patch/contacts/{id}

Update a contact (partial)

Auth

No detailed description provided for this operation in the OpenAPI spec.

operationId: ContactsController_updatetag: contactspermalink

post/contacts/bulk

Bulk-import contacts

Auth

Import multiple contacts at once (e.g. from device contacts). Only users registered on the platform are added; others are skipped with a reason.

operationId: ContactsController_createBulktag: contactspermalink