getAccounts — Retrieving a list of accounts

The getAccounts method retrieves a list of user accounts, sites, and site statuses. The results can be used to update your internal tracking of SiteLock accounts. To protect API resources and client XML parsing, the offset and limit elements are available to assist with looping through the accounts list.

The read-only API endpoint is:

https://api.sitelock.com/v1/partner

Request format

SiteLockOnlineRequest: This element is used to delineate the full API request.
- authentication: The partner’s username, password, and branding
  - username: The partner’s API username
  - password: The partner’s API password
  - partner: (Optional) The brand name to use in messaging
- getAccounts: The method name
  - limit: The number of accounts to return
  - offset: The number of accounts to skip when returning a set of data

Example request

<SiteLockOnlineRequest>
    <authentication>
        <user>Username</user>
        <password>Password</password>
    </authentication>
    <getAccounts>
        <limit>3</limit>
        <offset>0</offset>
    </getAccounts>
</SiteLockOnlineRequest>

Response format

SiteLockOnlineResponse: This element is used to delineate the full API response.
- getAccounts: The method name
  - records: The number of accounts returned
  - account: (Repeatable) A user account
    
    id: [attribute] - The ID of the account
    
    status: [attribute] - Either active or inactive
    
    site: (Repeatable) The site information
    
    id: [attribute] - The ID of the site
    
    status: [attribute] - Either active or inactive
    
    name: [attribute] - The hostname

Example success response

The API responds with a result of Success in every case except when you have passed in an invalid limit.

<SiteLockOnlineResponse>
    <getAccounts>
        <records>3</records>
        <account id="1227" status="active" >
            <site id="11175" status="inactive" name="www.dom.com" />
        </account>
        <account id="1228" status="active" >
            <site id="11176" status="active" name="dom1.tel" />
        </account>
        <account id="1229" status="active" >
            <site id="11177" status="active" name="dom2.com" />
        </account>
    </getAccounts>
</SiteLockOnlineResponse>

Example error response

<SiteLockOnlineResponse>
    <getAccounts>
        <error>limit can not be > 10000</error>
    </getAccounts>
</SiteLockOnlineResponse>

Error codes

limit can not be > 10000