Your Gridly subscription tier determines which API endpoints you can access and use. This article explains how API availability works across different subscription plans and provides a detailed breakdown of what's available at each tier.
How API access works
Gridly offers three API levels that provide progressive access to functionality, with each subscription tier corresponding to a specific API level:
| Subscription tier | API level | Description |
|---|---|---|
| Basic | Basic API level | Core functionality |
| Teams | Advanced API level | Everything in Basic plus advanced endpoints |
| Enterprise | Full API level | All available endpoints |
If you try to use an endpoint that requires a higher API level than your subscription includes, the API request will return an error.
Detailed API availability
Basic API level
| API Group | API Name |
|---|---|
| Authentication | Authentication |
| Project | Project resource |
| Project | List projects |
| Project | Retrieve a project |
| Database | Database resource |
| Database | List databases |
| Database | Retrieve a database |
| Grid | Grid resource |
| Grid | List grids |
| Grid | Retrieve a grid |
| View | View resource |
| View | List views |
| View | Retrieve a view |
| View | Import |
| View | Export |
| Column | Column resource |
| Column | Predefined columns |
| Column | Retrieve a column |
| Dependency | Dependency resource |
| Dependency | List dependencies |
| Dependency | Retrieve a dependency |
| Record | Pagination |
| Record | Filtering |
| Record | Sorting |
| Record | Record resource |
| Record | List records |
| Record | Add records |
| Record | Update records |
| Record | Update a single record |
| Record | Delete records |
| Record | Upload file |
| Record | Download file |
| Record | Delete file |
| Task | Retrieve a task |
| Path | Get path tree |
| Glossary | Glossary resource |
| Glossary | List glossaries |
| Glossary | Retrieve a glossary |
| Translation Memory | Translation Memory (TM) resource |
| Translation Memory | List TMs |
| Translation Memory | Retrieve a TM |
| Automation | AutomationResource |
| Automation | List automations |
| Automation | Retrieve an automation |
| Automation | List executions of an automation |
| Automation | Retrieve an execution |
| CDN | CDN Resource |
| CDN | List CDN |
| CDN | Publish CDN |
| CDN | Unpublish CDN |
Advanced API level
Everything in Basic, plus:
| API Group | API Name |
|---|---|
| Grid | Create grid |
| Grid | Update a grid |
| Grid | Delete a grid |
| View | Create view |
| Column | Create a column |
| Column | Update a column |
| Column | Delete a column |
| Dependency | Create a dependency |
| Dependency | Update a dependency |
| Dependency | Delete a dependency |
| Record | Batch upload |
| Branch | List branches |
| Branch | Retrieve a branch |
| Branch | Create a branch |
| Branch | Delete a branch |
| Path | Create paths |
| Path | Update the leaf folder in the path |
| Path | Move paths |
| Path | Delete paths |
| Glossary | Create glossary |
| Glossary | Update a glossary |
| Translation Memory | Export TM |
Full API level
Everything in Basic and Advanced, plus:
| API Group | API Name |
|---|---|
| View | Merge a view |
| View | Create shareable link |
| View | Get shareable link |
| View | Disable shareable link |
| Column | Add a column to a view |
| Column | Remove a column from a view |
| Record | Get record history |
| Branch | Merge a branch |
| Branch | Generate diffcheck |
| Branch | Get diffcheck record |
| Glossary | Delete a glossary |
| Glossary | Import glossary |
| Glossary | Export glossary |
| Translation Memory | Create TM |
| Translation Memory | Update a TM |
| Translation Memory | Delete a TM |
| Translation Memory | Import TM |
| Translation Memory | Upload TM |
| Automation | Trigger an automation |