How to Access API Documentation

To access Zip's API documentation, log in to your Zip account and click the question mark icon.

Then, select API Documentation from the drop-down menu.

After that, Zip automatically handles the authentication into the gated API docs and the API documentation opens in a new tab.

1. The API Reference tab is selected by default.  This features a list of end points on the left-hand side; select an endpoint to learn more about the various methods and parameters used by the API.
2. The Guides tab contains long-form explanations of basic Zip functionality and examples of common API implementations.

For implementation guidance, see the Guides in the API documentation. They cover topics such as API authentication, API rate limits, and managing paginated responses.

Share Access to the API Documentation

To give an engineer or external security reviewer access, use one of the following options:

• Create a read-only Zip user: Create a read-only account for the person who needs access. They can then sign in to Zip and open the API documentation.
• Request relevant excerpts: If creating a Zip account is not appropriate, contact your Zip point of contact to request the relevant excerpts from the API documentation.