List Account contacts

GET /accounts/{id}/contacts
Copied
Arrow
                https://api.ocamba.com/v2/ocamba/accounts/{id}/contacts

Returns a list of Account contacts

path Parameters
Arrow
Name
Description
account_idstringrequired
Unique account identifier defined as a path parameter.


Example: 12345
query Parameters
Arrow
Name
Description
q_fieldsstring
Use the q_fields parameter to list all fields you want to include in the search using q parameter. Note that not all fields are searchable on a specific object. If parameter q_fields is not specified, search is performed on a default search field.

Examples:
GET /v2/ocamba/members?q=sou&q_fields=lname → API retuns members whose lname contains string 'sou'.
GET /v2/ocamba/members?q=sou&q_fields=fname,lname,email → API returns members that contain string 'sou' in any of the specified fields.

See tips for the list of searchable parameters.

qstring
Set the q parameter value to search for a keyword or search term.

Example:
GET /v2/ocamba/members?q=sou → returns members that contain string 'sou'

See tips for the list of searchable parameters.

Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ account-contact ]
An array of all created items.
Account Contact
Name
Description
idstring (uuid)
A unique identifier generated by the Ocamba platform.


Example: 95eb301b-6aaf-42ad-a219-ccbd5f4d3d2b
typestring
Describes type of the contact.


Example: email

Possible values: phone | mobile | skype | sip | email | website
valuestring
The actual contact, based on contact type. For example, if contact type is email, the value must be a valid email address.


Example: [email protected]
totalinteger
A total number of items.


Example: 3
tip
1 If you don't know the account id, list the accounts to find it.
Response examples
Copied
Arrow
200 Arrow
  • 200
{
  "total": 3,
  "items": [
    {
      "id": "95eb301b-6aaf-42ad-a219-ccbd5f4d3d2b",
      "type": "email",
      "value": "[email protected]"
    }
  ]
}