Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.go.gbgplc.com/llms.txt

Use this file to discover all available pages before exploring further.

Before you can use the GBG GO API, you must authenticate your request. This involves exchanging your credentials for an access token.

​
What you need

Before requesting an access token, make sure you have the following API credentials:
  • Client ID: Identifies your organization.
  • Client secret: A secure key linked to your Client ID.
  • Username: The API username provided for your account.
  • Password: A temporary password set during account creation (must be changed before use).
You receive these credentials from your GBG account manager.

​
Request an access token

To get your access token, send a POST request to the endpoint. You can send a request like this:
BASH
curl --request POST \
  --url https://api.auth.gbgplc.com/as/token.oauth2 \
  --header 'accept: application/json' \
  --header 'content-type: application/x-www-form-urlencoded' \
  --data 'client_id=your-client-id&client_secret=your-client-secret&username=your-username&password=your-password&grant_type=password'
If your request is successful, the API will return a response in this format:
JSON
{
  "access_token": "your-access-token",
  "token_type": "Bearer",
  "expires_in": 3600
}
Store your access token securely and refresh it when it expires. Refer to the Generate access token API reference for details on the request and response definitions.

​
FAQ

To authenticate, send a POST request to the token endpoint:
JSON
https://api.auth.gbgplc.com/as/token.oauth2
The request must be sent with the following parameters:
ParameterDescription
client_idThe client ID.
client_secretThe client secret.
usernameYour API username.
passwordYour API password.
grant_typeSet to password.
Example request:
BASH
curl --request POST \
  --url https://api.auth.gbgplc.com/as/token.oauth2 \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'client_id=your-client-id&client_secret=your-client-secret&username=your-username&password=your-password&grant_type=password'
A successful response returns:
{
  "access_token": "your-access-token",
  "token_type": "Bearer",
  "expires_in": 3600
}
Include the token in the Authorization header of subsequent API request as Bearer your-access-token. Store the token securely and refresh it before it expires.You can obtain your API credentials (client ID, client secret, username, and temporary password) from your GBG account manager.
If you have forgotten your password:
  1. Go to the GBG GO sign-in page.
  2. Click Forgot your password? on the login screen.
  3. Check your email for a recovery code and enter it in the recovery code field.
  4. Enter a new password and confirm it.
  5. Click Change Password to save your new password.

​
Next step

Go to Step 2: Start a journey to create a new journey instance.