OnTime REST API
OnTime REST API / REST Endpoints Resource Group / api/customers (Get)
In This Topic
    Getapi/customers
    In This Topic

    Resource Path: /sites/{company-id}/api/customers

    Uri: https://secure.ontime360.com/sites/{company-id}/api/customers

    Description
    Finds and returns unique identifiers for all Customers that match a given criteria.
    Parameters
    NameDescriptionData Type
    The account number of a Customer as a String.string
    The exact street address of a Customer as a String.string
    The city or locality a Customer resides within as a String.string
    The country or national political entity of a Customer as a String.string
    The email of a Customer as a String.string
    The active status of a Customer as a Boolean.boolean
    The name of a Customer as a String.string
    The postal code of a Customer as a String.string
    Name of the primary contact of a Customer as a String.string
    The reference number of a Customer as a String.string
    The state, province, or other civil entity a Customer resides within as a String.string
    200 Response

    The response body is of type Array[].

    An array of unique Guid identifiers assigned to matching Customer objects.
    Fault Responses
    FaultDescription
    Request was improperly formatted, contained invalid data, or contained incorrect values. See response body for more information.
    Authorization key is invalid or no longer exists.
    Authorization key does not have permission to perform this action, or does not have permission to access the requested data. See response body for more information.
    See Also