Endpoints/URLs

The URL for the endpoints of the API have the following form:

https://matrix{-stage}.ag5.com/api/orgkeep/{orgid}/{slug}/v4/{endpoint}

The stage refers to the stage/environment the repositories live in:

stage
description

Production (i.e. no explicit stage named)

acceptance

Acceptance/test environment

prerelease

Pre-release environment

dev

Development environment (mostly internal)

The slug parameter will be provided when an API account is requested.

As an example, the following URL should be used to access the List employees endpoint in the acceptance environment (of some fictional company Acme Corporation):

https://matrix-acceptance.ag5.com/api/orgkeep/acme/orgkeep/v4/employees

Was this helpful?