Rest API

Connect API Gateway URL

Each of our environments uses its own Connect API gateway, so the partner's application should expose this gateway URL from the Connect token instead of using a fixed URL.

You can find the API URL in the token payload in the object attribute fn-ext within the attribute apiBase. Please take care of protocol and port to integrate successfully.

Available REST Endpoints

See the Swagger section for more details.

Active and Inactive Data

Most REST resources provide only active data by default in list requests.

You can request inactive data by adding the query parameter withInactive=true if supported by the resource. See the endpoint definitions for more details.

The inactive data is included in the response along with the active data. You cannot request inactive data only.

Example request for inactive data