Server API Parameters

Common Server Parameters

See topic Common Parameters.

list_page_size

Optional. The number of results in each page (used with "list_record_offset").

Type xsd:int.

list_record_offset

Optional. The requested initial record number (used with "list_page_size"). The first record (default) is zero.

Type xsd:int.

list_sort_column

Optional. The column to sort by. Options are: name, category_id, number_of_employees, url.

Type xsd:string.

list_ascending

Optional. If true, the returned list will be sorted in ascending order, if false, descending order. Default is true.

Type xsd:boolean.

name

Optional. Only return results matching this partial name.

Type xsd:string.

Response

See topic HTTP Status Codes.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<listOrganizationsResponse xmlns="http://convio.com/crm/v1.0">
    <organization>
        <org_id>100</org_id>
        <name>Test Organization</name>
        <url>http://sample.url</url>
        <category_id>5</category_id>
        <num_employees>10</num_employees>
    </organization>
    <organization>
        <org_id>101</org_id>
        <name>Sample Org Inc</name>
        <url>http://sampleorg.url</url>
        <category_id>5</category_id>
        <num_employees>15</num_employees>
    </organization>
</listOrganizationsResponse>


        

{"listOrganizationsResponse":{"organization":[{"org_id":"100","name":"Test Organization","category_id":"5","url":"http://sample.url","num_employees":"10"},{"org_id":"101","name":"Sample Org Inc","category_id":"5","url":"http://sampleorg.url","num_employees":"15"}]}}