Contacts

Contact management and custom attributes

List contacts

get

Get all contacts with pagination. Searchable: firstName, lastName, fullName, primaryPhone, primaryEmail.

Authorizations

BearerAuth

AuthorizationstringRequired

API key provided by GoMobile team. Request yours at https://docs.google.com/forms/d/1F6_7OIDNq8_lWgKPyP-DudF3dvBTl31X4dqVf5St2zE

Query parameters

pageintegerOptionalDefault: 1

limitinteger · max: 100OptionalDefault: 20

searchstringOptional

sortBystring · enumOptionalPossible values:

sortOrderstring · enumOptionalDefault: descPossible values:

Responses

200

Paginated list of contacts

application/json

401

Unauthorized

get

/contact

HTTPcURLJavaScriptPython

GET /api/contact HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "organizationId": "123e4567-e89b-12d3-a456-426614174000",
      "firstName": "text",
      "lastName": "text",
      "fullName": "text",
      "primaryEmail": "text",
      "primaryPhone": "text",
      "address": "text",
      "city": "text",
      "state": "text",
      "zip": "text",
      "occupation": "text",
      "preferredChannel": "text",
      "gender": "male",
      "channels": [
        {
          "type": "text",
          "value": "text",
          "isPrimary": true
        }
      ],
      "createdAt": "2026-02-16T20:52:49.061Z",
      "updatedAt": "2026-02-16T20:52:49.061Z",
      "deletedAt": "2026-02-16T20:52:49.061Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 1,
    "total": 1,
    "totalPages": 1,
    "hasNextPage": true,
    "hasPreviousPage": true
  }
}

Create contact

post

Authorizations

BearerAuth

AuthorizationstringRequired

API key provided by GoMobile team. Request yours at https://docs.google.com/forms/d/1F6_7OIDNq8_lWgKPyP-DudF3dvBTl31X4dqVf5St2zE

Body

application/json

firstNamestringOptional

lastNamestringOptional

fullNamestringOptional

primaryEmailstring · emailOptional

primaryPhonestringRequired

addressstringOptional

citystringOptional

statestringOptional

zipstringOptional

occupationstringOptional

preferredChannelstringOptional

customAttributesobjectOptional

genderstring · enumOptionalPossible values:

channelsstring[]Optional

Responses

201

Contact created

application/json

400

Invalid input

401

Unauthorized

409

Phone number already exists

post

/contact

HTTPcURLJavaScriptPython

POST /api/contact HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 273

{
  "firstName": "text",
  "lastName": "text",
  "fullName": "text",
  "primaryEmail": "[email protected]",
  "primaryPhone": "text",
  "address": "text",
  "city": "text",
  "state": "text",
  "zip": "text",
  "occupation": "text",
  "preferredChannel": "text",
  "customAttributes": {},
  "gender": "male",
  "channels": [
    "text"
  ]
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "firstName": "text",
  "lastName": "text",
  "fullName": "text",
  "primaryEmail": "text",
  "primaryPhone": "text",
  "address": "text",
  "city": "text",
  "state": "text",
  "zip": "text",
  "occupation": "text",
  "preferredChannel": "text",
  "gender": "male",
  "channels": [
    {
      "type": "text",
      "value": "text",
      "isPrimary": true
    }
  ],
  "createdAt": "2026-02-16T20:52:49.061Z",
  "updatedAt": "2026-02-16T20:52:49.061Z",
  "deletedAt": "2026-02-16T20:52:49.061Z"
}

Bulk upsert contacts

post

Bulk upsert contacts. Existing contacts matched by phone number.

Authorizations

BearerAuth

AuthorizationstringRequired

API key provided by GoMobile team. Request yours at https://docs.google.com/forms/d/1F6_7OIDNq8_lWgKPyP-DudF3dvBTl31X4dqVf5St2zE

Body

application/json

Responses

201

Contacts upserted

400

Invalid input

401

Unauthorized

post

/contact/upsert

HTTPcURLJavaScriptPython

POST /api/contact/upsert HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 284

{
  "data": [
    {
      "firstName": "text",
      "lastName": "text",
      "fullName": "text",
      "primaryEmail": "[email protected]",
      "primaryPhone": "text",
      "address": "text",
      "city": "text",
      "state": "text",
      "zip": "text",
      "occupation": "text",
      "preferredChannel": "text",
      "customAttributes": {},
      "gender": "male",
      "channels": [
        "text"
      ]
    }
  ]
}

No content

Get contact by ID

get

Get contact with custom attributes.

Authorizations

BearerAuth

AuthorizationstringRequired

API key provided by GoMobile team. Request yours at https://docs.google.com/forms/d/1F6_7OIDNq8_lWgKPyP-DudF3dvBTl31X4dqVf5St2zE

Path parameters

idstring · uuidRequired

Responses

200

Contact with attributes

application/json

401

Unauthorized

404

Contact not found

get

/contact/{id}

HTTPcURLJavaScriptPython

GET /api/contact/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "firstName": "text",
  "lastName": "text",
  "fullName": "text",
  "primaryEmail": "text",
  "primaryPhone": "text",
  "address": "text",
  "city": "text",
  "state": "text",
  "zip": "text",
  "occupation": "text",
  "preferredChannel": "text",
  "gender": "male",
  "channels": [
    {
      "type": "text",
      "value": "text",
      "isPrimary": true
    }
  ],
  "createdAt": "2026-02-16T20:52:49.061Z",
  "updatedAt": "2026-02-16T20:52:49.061Z",
  "deletedAt": "2026-02-16T20:52:49.061Z",
  "customAttributes": [
    {
      "name": "text",
      "displayName": "text",
      "description": "text",
      "type": "text",
      "value": null,
      "isLocked": true
    }
  ]
}

Update contact

put

Authorizations

BearerAuth

AuthorizationstringRequired

API key provided by GoMobile team. Request yours at https://docs.google.com/forms/d/1F6_7OIDNq8_lWgKPyP-DudF3dvBTl31X4dqVf5St2zE

Path parameters

idstring · uuidRequired

Body

application/json

firstNamestringOptional

lastNamestringOptional

fullNamestringOptional

primaryEmailstring · emailOptional

primaryPhonestringOptional

addressstringOptional

citystringOptional

statestringOptional

zipstringOptional

occupationstringOptional

preferredChannelstringOptional

customAttributesobjectOptional

genderstring · enumOptionalPossible values:

channelsstring[]Optional

Responses

200

Contact updated

application/json

401

Unauthorized

404

Contact not found

put

/contact/{id}

HTTPcURLJavaScriptPython

PUT /api/contact/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 273

{
  "firstName": "text",
  "lastName": "text",
  "fullName": "text",
  "primaryEmail": "[email protected]",
  "primaryPhone": "text",
  "address": "text",
  "city": "text",
  "state": "text",
  "zip": "text",
  "occupation": "text",
  "preferredChannel": "text",
  "customAttributes": {},
  "gender": "male",
  "channels": [
    "text"
  ]
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "firstName": "text",
  "lastName": "text",
  "fullName": "text",
  "primaryEmail": "text",
  "primaryPhone": "text",
  "address": "text",
  "city": "text",
  "state": "text",
  "zip": "text",
  "occupation": "text",
  "preferredChannel": "text",
  "gender": "male",
  "channels": [
    {
      "type": "text",
      "value": "text",
      "isPrimary": true
    }
  ],
  "createdAt": "2026-02-16T20:52:49.061Z",
  "updatedAt": "2026-02-16T20:52:49.061Z",
  "deletedAt": "2026-02-16T20:52:49.061Z"
}

Delete contact (soft)

delete

Authorizations

BearerAuth

AuthorizationstringRequired

API key provided by GoMobile team. Request yours at https://docs.google.com/forms/d/1F6_7OIDNq8_lWgKPyP-DudF3dvBTl31X4dqVf5St2zE

Path parameters

idstring · uuidRequired

Responses

200

Contact deleted

application/json

401

Unauthorized

404

Contact not found

delete

/contact/{id}

HTTPcURLJavaScriptPython

DELETE /api/contact/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  "firstName": "text",
  "lastName": "text",
  "fullName": "text",
  "primaryEmail": "text",
  "primaryPhone": "text",
  "address": "text",
  "city": "text",
  "state": "text",
  "zip": "text",
  "occupation": "text",
  "preferredChannel": "text",
  "gender": "male",
  "channels": [
    {
      "type": "text",
      "value": "text",
      "isPrimary": true
    }
  ],
  "createdAt": "2026-02-16T20:52:49.061Z",
  "updatedAt": "2026-02-16T20:52:49.061Z",
  "deletedAt": "2026-02-16T20:52:49.061Z"
}