API Guide







Get Child Account(s)

This API call provides a broad overview of children account(s) including the email address, API key, enabled products, and the current/max usage of those products. Data is returned in the following formats: XML, JSON, CSV and Serialized.

Required headers: X-API-KEY
Optional headers: ACCEPT (json, xml, csv, serialized)
Method: GET

Endpoint URL:

https://api.250ok.com/api/1.0/account/childaccount

Sample Output:

[
    {
        'id' => '1',
        'email' => 'email@domain.com',
        'external_id' => 'abc123',
        'api_key' => 'def456',
        'company' => '259ij',
        'has_inboxinformant' => 'yes',
        'inbox_max' => '100',
        'inbox_used' => '23',
        'inbox_expires' => '12/31/2016',
        'has_blacklistinformant' => 'yes',
        'blacklist_max' => '15',
        'blacklist_used' => '6',
        'blacklist_expires' => '12/31/2016',
        'has_reputation' => 'n',
        'reputation_expires' => '12/31/2016',
        'has_designinformant' => 'n',
        'design_max' => '100',
        'design_used' => '2',
        'design_expires' => '12/31/2016',
        'emailinformant_expires' => '',
        'has_emailinformant' => 'yes',
        'emailinformant_max' => '5000000',
        'emailinformant_used' => '1250000',
        'emailinformant_expires' => '12/31/2016',
        'has_dmarc' => 'yes',
        'dmarc_max' => '1000000',
        'dmarc_used' => '500000',
        'dmarc_expires' => '12/31/2016'
    }
]
        

Parameters

Parameter Description Acceptable Values Required
id The unique identifier of the child account. Integer N
external_id The external identifier of the alias. String N

Error Responses

Description Code Cause
Invalid child account ID. 404 The unique identifier of the child account is invalid
This child account does not exist. 404 We couldn't find an account with the child account ID provided
You don't have access to this child account. 403 The child account is not owned by the parent account provided in the API key