Contacts

Operations for managing contacts

Get Contact

Retrieve a contact by its ID

GET

https://dev.officex.app/v1/drive/{organization_id}/contacts/get/{contact_id}

Run In Postman

Path Parameter

organization_id (required)	string (DriveID) Unique identifier for a drive	DriveID_abc123
contact_id (required)	string (UserID) ID of the contact to retrieve	UserID_abcdef123456

Header Parameters

Authorization (required)	stringBearer TOKEN Bearer token for authentication	Bearer eyJhbGciOiJIUz...

Responses

success

{
    "ok": {
        "data": {
            "id": "UserID_c5hjz-wpnfl-3v2jx-hglmv-6y7wm-o6zur-e6q2n-e7vp3-4z762-ajc7l-mqe",
            "name": "manzy",
            "avatar": "",
            "email": "",
            "notifications_url": "",
            "public_note": "",
            "private_note": "",
            "evm_public_address": "",
            "icp_principal": "c5hjz-wpnfl-3v2jx-hglmv-6y7wm-o6zur-e6q2n-e7vp3-4z762-ajc7l-mqe",
            "seed_phrase": "",
            "from_placeholder_user_id": "UserID_c5hjz-wpnfl-3v2jx-hglmv-6y7wm-o6zur-e6q2n-e7vp3-4z762-ajc7l-mqe",
            "redeem_code": "RedeemTokenID_dd090970-fcb1-49bc-af35-69eba1a157f5",
            "created_at": 1755445000597,
            "last_online_ms": 0,
            "external_id": null,
            "external_payload": null,
            "secret_entropy": "",
            "permission_previews": [
                "CREATE",
                "VIEW",
                "EDIT",
                "DELETE",
                "INVITE"
            ],
            "labels": [],
            "group_previews": [
                {
                    "group_id": "GroupID_b76e4405-d850-4685-88b8-c66744255724",
                    "invite_id": "GroupInviteID_e8479d67-0806-4ee3-bb75-6ff5245ee21e",
                    "is_admin": false,
                    "group_name": "Group for All",
                    "group_avatar": ""
                }
            ]
        }
    }
}

error

{
  "err": {
    "code": 0,
    "message": "string"
  }
}

Typescript Types

	type
Request	IRequestGetContact
Response	IResponseGetContact

---

List Contacts

List contacts with optional filtering and pagination

POST

https://dev.officex.app/v1/drive/{organization_id}/contacts/list

Run In Postman

Header Parameters

Authorization (required)	stringBearer TOKEN Bearer token for authentication	Bearer eyJhbGciOiJIUz...

Path Parameter

organization_id (required)	string (DriveID) Unique identifier for a drive	DriveID_abc123

Request Body schema:

filters	string <= 256 characters Default: "" Filter string for contacts
page_size	integer [ 1 .. 1000 ] Default: 50 Number of items per page	50
direction	string Default: "ASC" Enum: "ASC" "DESC" Sort direction	ASC
cursor_up	string or null <= 256 characters Cursor for pagination (previous page)	string
cursor_down	string or null <= 256 characters Cursor for pagination (next page)	string

Responses

success

{
  "filters": "",
  "page_size": 50,
  "direction": "ASC",
  "cursor_up": "string",
  "cursor_down": "string"
}

error

{
  "err": {
    "code": 0,
    "message": "string"
  }
}

Typescript Types

	type
Request	IRequestListContacts
Response	IResponseListContacts

---

Create Contact

Create a new contact

POST

https://dev.officex.app/v1/drive/{organization_id}/contacts/create

Run In Postman

Header Parameters

Authorization (required)	stringBearer TOKEN Bearer token for authentication	Bearer eyJhbGciOiJIUz...

Path Parameter

organization_id (required)	string (DriveID) Unique identifier for a drive	DriveID_abc123

Request Body schema:

id (required)	string (UserID) Unique identifier for a user	UserID_abc123
name	string <= 256 characters Name for the contact	John Doe
avatar	string or null <= 2048 characters Profile picture URL
notifications_url	string <= 256 characters Alternative of email notifications
email	string or null <= 256 characters Primary email for the contact
evm_public_address	string (EvmPublicAddress) EVM public address.
public_note	string or null <= 8192 characters Public note about the contact	Project manager for Alpha group
private_note	string or null <= 8192 characters Private note about the contact	Primary contact for urgent issues
external_id	string (ExternalID) <= 256 characters External identifier for integration purposes
external_payload	string (ExternalPayload) <= 8192 characters Additional data for external integrations. Eg Stringified JSON

Responses

success

{
    "ok": {
        "data": {
            "id": "UserID_67q5a-2manu-6wyl6-6onic-pvqe4-bydge-lhy4g-22nvo-hcact-5qmki-yae",
            "name": "John Doe",
            "avatar": "",
            "email": "",
            "notifications_url": "",
            "public_note": "Project manager for Alpha group",
            "private_note": "Primary contact for urgent issues",
            "evm_public_address": "",
            "icp_principal": "67q5a-2manu-6wyl6-6onic-pvqe4-bydge-lhy4g-22nvo-hcact-5qmki-yae",
            "seed_phrase": "",
            "secret_entropy": "",
            "labels": [],
            "created_at": 1755445239883,
            "last_online_ms": 0,
            "permission_previews": [
                "CREATE",
                "VIEW",
                "EDIT",
                "DELETE",
                "INVITE"
            ],
            "group_previews": [
                {
                    "group_id": "GroupID_b76e4405-d850-4685-88b8-c66744255724",
                    "invite_id": "GroupInviteID_c9b969bf-5a53-4f27-86eb-2c8c803dd4dd",
                    "is_admin": false,
                    "group_name": "Group for All",
                    "group_avatar": ""
                }
            ]
        }
    }
}

error

{
  "err": {
    "code": 0,
    "message": "string"
  }
}

Typescript Types

	type
Request	IRequestCreateContact
Response	IResponseCreateContact

---

Update Contact

Update a contact'

POST

https://dev.officex.app/v1/drive/{organization_id}/contacts/update

Run In Postman

Header Parameters

Authorization (required)	stringBearer TOKEN Bearer token for authentication	Bearer eyJhbGciOiJIUz...

Path Parameter

organization_id (required)	string (DriveID) Unique identifier for a drive	DriveID_abc123

Request Body schema

id (required)	string (UserID) Unique identifier for a user	UserID_67q5a-2manu-6wyl6-6onic-pvqe4-bydge-lhy4g-22nvo-hcact-5qmki-yae
name	string <= 256 characters Name for the contact	Johnny the Kid, Doe
avatar	string or null <= 2048 characters Profile picture URL
notifications_url	string <= 256 characters Alternative of email notifications
email	string or null <= 256 characters Primary email for the contact
evm_public_address	string (EvmPublicAddress) EVM public address.
public_note	string or null <= 8192 characters Public note about the contact	Senior Project Manager for Bark Group
private_note	string or null <= 8192 characters Private note about the contact	Recently promoted, great communicator
external_id	string (ExternalID) <= 256 characters External identifier for integration purposes
external_payload	string (ExternalPayload) <= 8192 characters Additional data for external integrations. Eg Stringified JSON	"{"department": "product", "title": "Lead Project Manager", "location": "Remote", "updated": true}"

Responses

success

{
    "ok": {
        "data": {
            "id": "UserID_67q5a-2manu-6wyl6-6onic-pvqe4-bydge-lhy4g-22nvo-hcact-5qmki-yae",
            "name": "Johnny the Kid, Doe",
            "avatar": "",
            "email": "",
            "notifications_url": "",
            "public_note": "Senior Project Manager for Bark Group",
            "private_note": "Recently promoted, great communicator",
            "evm_public_address": "",
            "icp_principal": "67q5a-2manu-6wyl6-6onic-pvqe4-bydge-lhy4g-22nvo-hcact-5qmki-yae",
            "seed_phrase": "",
            "from_placeholder_user_id": null,
            "redeem_code": null,
            "created_at": 1755445239883,
            "last_online_ms": 0,
            "external_id": "",
            "external_payload": "{\"department\": \"product\", \"title\": \"Lead Project Manager\", \"location\": \"Remote\", \"updated\": true}",
            "secret_entropy": "",
            "permission_previews": [
                "CREATE",
                "VIEW",
                "EDIT",
                "DELETE",
                "INVITE"
            ],
            "labels": [],
            "group_previews": [
                {
                    "group_id": "GroupID_b76e4405-d850-4685-88b8-c66744255724",
                    "invite_id": "GroupInviteID_c9b969bf-5a53-4f27-86eb-2c8c803dd4dd",
                    "is_admin": false,
                    "group_name": "Group for All",
                    "group_avatar": ""
                }
            ]
        }
    }
}

error

{
  "err": {
    "code": 0,
    "message": "string"
  }
}

Typescript Types

	type
Request	IRequestUpdateContact
Response	IResponseUpdateContact

Delete Contact

Delete an existing contact

POST

https://dev.officex.app/v1/drive/{organization_id}/contacts/delete

Run In Postman

Header Parameters

Authorization (required)	stringBearer TOKEN Bearer token for authentication	Bearer eyJhbGciOiJIUz...

Path Parameter

organization_id (required)	string (DriveID) Unique identifier for a drive	DriveID_abc123

Request Body schema

id (required)	string (UserID) Unique identifier for a user	UserID_67q5a-2manu-6wyl6-6onic-pvqe4-bydge-lhy4g-22nvo-hcact-5qmki-yae

Responses

success

{
    "ok": {
        "data": {
            "id": "UserID_67q5a-2manu-6wyl6-6onic-pvqe4-bydge-lhy4g-22nvo-hcact-5qmki-yae",
            "deleted": true
        }
    }
}

error

{
  "err": {
    "code": 0,
    "message": "string"
  }
}

Typescript Types

	type
Request	IRequestDeleteContact
Response	IResponseDeleteContact

Redeem a Contact

Redeems a contact and superswap replace the old user id

POST

https://dev.officex.app/v1/drive/{organization_id}/contacts/redeem

Run In Postman

Header Parameters

Authorization (required)	stringBearer TOKEN Bearer token for authentication	Bearer eyJhbGciOiJIUz...

Path Parameter

organization_id (required)	string (DriveID) Unique identifier for a drive	DriveID_abc123

Request Body schema

current_user_id	string (UserID) Unique identifier for a user	UserID_ocjx7-nigdl-juj3n-5m3cu-2c7g3-hyqrv-hupit-c76dw-dnc67-slomg-hqe
new_user_id	string (UserID) Unique identifier for a user	UserID_ocjx7-nigdl-juj3n-5m3cu-2c7g3-hyqrv-hupit-c76dw-dnc67-slomg-hqe
redeem_code	string Redemption code to prove authority .it starts with RedeemTokenID_	RedeemTokenID_0e24ef27-21a6-4ac7-9c13-99ab752a93b9

Responses

success

{
    "ok": {
        "data": {
            "contact": {
                "id": "UserID_ocjx7-nigdl-juj3n-5m3cu-2c7g3-hyqrv-hupit-c76dw-dnc67-slomg-hqe",
                "name": "person2",
                "avatar": "",
                "email": "",
                "notifications_url": "",
                "public_note": "",
                "private_note": "",
                "secret_entropy": "",
                "evm_public_address": "",
                "icp_principal": "ocjx7-nigdl-juj3n-5m3cu-2c7g3-hyqrv-hupit-c76dw-dnc67-slomg-hqe",
                "seed_phrase": "",
                "from_placeholder_user_id": "UserID_ghf7e-v6cqw-pupvd-qojec-uz3da-ptqum-i6l3g-y65ry-4f4yq-dejmn-sae",
                "redeem_code": null,
                "created_at": 1755523564446,
                "last_online_ms": 0,
                "external_id": null,
                "external_payload": null,
                "permission_previews": [
                    "CREATE",
                    "VIEW",
                    "EDIT",
                    "DELETE",
                    "INVITE"
                ],
                "labels": [],
                "group_previews": [
                    {
                        "group_id": "GroupID_5d7c60d3-b8dc-4990-9fe7-b81dc9ec7479",
                        "invite_id": "GroupInviteID_be90ddac-95f4-46a5-8a58-a750663516ae",
                        "is_admin": false,
                        "group_name": "Group for All",
                        "group_avatar": ""
                    }
                ]
            },
            "api_key": "eyJhdXRoX3R5cGUiOiJBUElfS0VZIiwidmFsdWUiOiI3YmQ5NGFmOTlhY2ZiNTM5YzNkMTc2OTdhMzFkYzRiYTM5MDc1ZmUzMzk3NWRhZDQ1YTdlOGI4ZTRmYWZmYzg2In0="
        }
    }
}

error

{
  "err": {
    "code": 0,
    "message": "string"
  }
}

Typescript Types

	type
Request	IRequestRedeemContact
Response	IResponseRedeemContact