How to Use the API

Endpoints

Contact the REST API using the following endpoint:
https://api.g001.enterprise.ipost.com/v1/

The old one https://g001.enterprise.ipost.com/api/v1/ is still valid but it is not preferred.

Please verify your iPost Enterprise instance. The endpoint URL should include the same instance as your iPost Enterprise account. You can verify what instance you are on by looking at the url in your browser when you are logged into your iPost Enterprise account.

If your iPost Enterprise account uses the g001 instance, use the following endpoint::
https://api.g001.enterprise.ipost.com/v1/

If your iPost Enterprise account uses the g002 instance, use the following endpoint:
https://api.g002.enterprise.ipost.com/v1/

If your iPost Enterprise account uses the g003 instance, use the following endpoint:
https://api.g003.enterprise.ipost.com/v1/

Authentication

To use the iPost Enterprise REST API, you will need to authenticate using your email and password by using the Authentication method below.
Subsequent calls will need your ClientToken as a URL parameter, which can be found here:
https://g001.enterprise.ipost.com/settings/client

Limitations

The API call should stay below 16KB per request in order to avoid being truncated.