Environments Endpoint

/api/partner/1.0/environments (GET)

Endpoint authentication

When adopting OAuth 2.0 as an authentication method, the below security requirements are needed in order to trigger this endpoint:

• The user must fulfill the below security roles requirements; if he fails to obtain access to all the necessary security roles, an error 403: Insufficient privileges to execute this request is returned:

  • The user must acquire access to at least one of the following security roles;

    • Tax – Access T1 Product

    • Tax – Access T2 Product

    • Tax – Access T3 Product

    • Tax – Access Forms Product

Endpoint description

Returns a list of environments without the list of templates for which each environment is linked.

Model	N/A
Properties	N/A

Examples

Request URL	https://mysite.cchifirm.ca/taxcan/api/partner/1.0/environments
Request body	N/A
Response body	{ "result": [ { "id": "fd4034ff-a123-3143-8b4b-58ff63686fc5", "name": "Default/Défaut", "description": "This is the default environment", "group1Id": -1, "group2Id": -1, "lastModificationTimestamp": "2021-08-11T17:55:05Z" }, { "id": "d6d50e87-7189-4ac9-b136-cc849412f4c3", "name": "My Environment", "description": "This is my environment", "group1Id": 1, "group2Id": 2, "lastModificationTimestamp": "2021-08-12T13:44:11Z" }, ], "errors": [] }