Companies

  • Return all of the user's companies

    GET /api/1/companies.json
    Formats
    json jsonp

    Returns an array of company objects belonging to the authenticated user Can take a URL-encoded, SQL-like query string and order string which can help filter and order the results that will be returned. So the query string:

    name ~= "quia+itaque"

    which lookes like this when URL encoded:

    /api/1/companies.json?where=name~%3D"quia+itaque"&order=name+asc

    will return all companies similar to “quia itaque” ordered by name in ascending order.

    Click here for more information on the API query string.

    Errors
    • 401 Unauthorized
    Example
    GET /api/1/companies
    200
    {
      "response": [
        {
          "contact_email_address": null,
          "contact_first_name": null,
          "contact_home_phone": null,
          "contact_last_name": null,
          "contact_mobile_phone": null,
          "contact_position": null,
          "contact_salutation": null,
          "fax_phone": null,
          "latitude": null,
          "longitude": null,
          "main_address": null,
          "main_city": null,
          "main_country": null,
          "main_phone": null,
          "main_postcode": null,
          "main_state": null,
          "name": "Durgan and Sons",
          "notes": null,
          "uuid": "16de762d-3ac9-4a87-8629-2c0550d6b585",
          "visibility": "private",
          "website": null,
          "user_uuids": [
            "1a7f0cae-3f49-4242-bbf7-f70574d8bcb5"
          ]
        },
        {
          "contact_email_address": null,
          "contact_first_name": null,
          "contact_home_phone": null,
          "contact_last_name": null,
          "contact_mobile_phone": null,
          "contact_position": null,
          "contact_salutation": null,
          "fax_phone": null,
          "latitude": null,
          "longitude": null,
          "main_address": null,
          "main_city": null,
          "main_country": null,
          "main_phone": null,
          "main_postcode": null,
          "main_state": null,
          "name": "Johnston, Hessel and Hermiston",
          "notes": null,
          "uuid": "50782442-0171-41a1-b9a7-85830d379725",
          "visibility": "private",
          "website": null,
          "user_uuids": [
            "1a7f0cae-3f49-4242-bbf7-f70574d8bcb5"
          ]
        },
        {
          "contact_email_address": null,
          "contact_first_name": null,
          "contact_home_phone": null,
          "contact_last_name": null,
          "contact_mobile_phone": null,
          "contact_position": null,
          "contact_salutation": null,
          "fax_phone": null,
          "latitude": null,
          "longitude": null,
          "main_address": null,
          "main_city": null,
          "main_country": null,
          "main_phone": null,
          "main_postcode": null,
          "main_state": null,
          "name": "Schumm LLC",
          "notes": null,
          "uuid": "3d0f1406-4768-401b-ae3f-0868f608936b",
          "visibility": "private",
          "website": null,
          "user_uuids": [
            "1a7f0cae-3f49-4242-bbf7-f70574d8bcb5"
          ]
        }
      ],
      "count": 3
    }
    Parameters
    • where

      An SQL-like query string which can filter the results that will be returned

    • order

      An SQL-like order string, that sets the order of the returned objects