e-Builder Public APIs

e-Builder's Application Programming Interface (API) provides you with the framework to create custom integrations between e-Builder and your other applications and tools. **Use of APIs in e-Builder** e-Builder's API is built on the REST protocol using JSON document payloads. Customers and partners can unlock the data stored in e-Builder to build data extraction integrations with a variety of systems. Developers have built integrations with ERPs, CRMs, CMSs, and data warehouses. Note: If your requirements go beyond data extraction, we offer more comprehensive integration capabilities through the AppXChange. # Getting Started The e-Builder documentation is built using the OpenAPI 3.0 documentation standard. This provides a consistent method for describing endpoints and providing request/response examples as well as code samples. The endpoints are grouped together by module. Each module and its endpoints are further described to help developers understand their usage. Each endpoint also includes a mock response example and response schema. ## Before You Start There is no special set-up required to use the e-Builder API; however, the instance should be fully configured and must be in use. Access to the API is granted by account administrators. Once your account is enabled for API Access, and you are granted an API Access Key, you can use the API for small data exports that can be pulled into and managed. More details on access can be found under the Authenticate resource. For the most up-to-date list of public API endpoints please visit: [https://api2.e-builder.net/swagger/ui/index#/](https://api2.e-builder.net/swagger/ui/index#/) ## Environments e-Builder has multiple environments available. When making API calls, ensure that the API subdomain matches your UI domain. For example, the base URL for the US1 Environment is [https://api2.e-builder.net](https://api2.e-builder.net) so the API endpoint used will be [https://api2.e-builder.net/api/v2/projects](https://api2.e-builder.net/api/v2/projects). Use the following list of base URLs for each UI environment to define the API Endpoint: | Environment | URL | | --- | --- | | US1 | [https://api2.e-builder.net](https://api2.e-builder.net) | | US2 | [https://api2-us2.e-builder.net](https://api2-us2.e-builder.net) | | US3 | [https://api2-us3.e-builder.net](https://api2-us3.e-builder.net) | | US4 | [https://api2-us4.e-builder.net](https://api2-us4.e-builder.net) | | Canada | [https://api2.ca.e-builder.net](https://api2.ca.e-builder.net) | | Gov Cloud | [https://gov-api2.e-builder.net](https://gov-api2.e-builder.net) | Your current environment url is {{baseUrl}} ## URI Parameters A URI Parameter is used to identify a specific resource or resources. For e-Builder APIs, all Uniform Resource Identifier (URI) parameters are optional. The most common parameters are limit, offset, schema and dates. ## Pagination API queries to dense databases could potentially return thousands of results. Pagination is a type of filtering that helps to limit the number of objects (limit) from a certain point (offset). When a limit count is given, no more than that many records will be returned. Limit specifies the maximum number of rows to return. An offset refers to the number of records you wish to skip before selecting records. By specifying the offset, you can retrieve a subset of records starting with the offset value. Offset starts at 0 for the first record. Records are ordered by the last modified date. Each API collection has slightly different parameters and limit values that they support. ## Filtering Filtering by other values will further limit the results returned after pagination. e-Builder supports the use of date filters on collections. ## Limits e-Builder APIs are subject to certain usage limits to protect our system infrastructure from over usage. Limiting API requests also ensures the fair distribution of system resources. e-Builder's annual subscription includes the following call limits: | Annual Subscription | Access Included | Additional $15,000 | | --- | --- | --- | | Call Limits | 5,000,000 | 10,000,000 | | Time Range | Quarterly | Quarterly | To purchase additional calls beyond the subscription limits, please contact e-Builder Support. ### Contact Support: Name: API Support Email: [[email protected]](https://mailto:[email protected])