Skip to content

Get contact organizations

Getting list of organization's contacts

Method get.contact_organizations
Description Getting list of organization's contacts
Who has access Agent, Customer

Parameters of the request

Title Type Required Description
access_token string yes Authentication session key
user_id number no Unique user ID of a customer or an agent who makes request.
Is mandatory for the agent
To access a list of customer users you need to use the method "get.customer_users"
limit number no Number of returned records. Refer to "Paging"
offset number no Offset that defines from which phone number to return "limit" of recordings. Default value is "0". Refer to "Paging"
filter object no Refer to "Filtering criteria"
fields array no Refer to "View returning errors"
sort array no Refer to "Sorting"

Parameters of a reply

Name Type Filtering Sorting Description
id number yes Unique ID of organization
name string yes yes Organization name

JSON request structure

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"get.contact_organizations",
  "params":{
    "access_token":"string",
    "user_id":"number",
    "offset":"number",
    "limit":"number",
    "filter":{

    },
    "sort":[
      {
        "field":"string",
        "order":"string"
      }
    ],
    "fields":[
      "string"
    ]
  }
}

JSON reply structure

{
  "jsonrpc":"2.0",
  "id":"number",
  "result":{
    "metadata":{

    },
    "data":[
      {
        "id":"number",
        "name":"string"
      }
    ]
  }
}

List of returning errors

Refer to "List of errors for methods with the verb get"