GBG

GBG Device API

The Device API from GBG — 4 operation(s) for device.

Documentation GitHub OpenAPI

Operations 4

POST /journey/device/start Generate connect token #

POST /journey/device/connect Complete the device-onboarding handshake #

POST /journey/device/refresh Renew a device session #

POST /journey/device/validate Validate end-user session #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/gbg:gbg-device-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Gbg Device API
  version: 2.0.0
  license:
    name: MIT
  description: 'Operations tagged Device across 2 of this provider''s published API definitions: gbg-go-v2-openapi.json, gbg-go-v2-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://eu.platform.go.gbgplc.com/v2/captain/
- url: https://us.platform.go.gbgplc.com/v2/captain/
- url: https://au.platform.go.gbgplc.com/v2/captain/
- url: https://api.auth.gbgplc.com/as/token.oauth2
security: []
tags:
- name: Device
paths:
  /journey/device/start:
    post:
      tags:
      - Device
      summary: Generate connect token
      description: Generates a one-time connect token for device onboarding.
      security:
      - CustomerAccess: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                instanceId:
                  type: string
                  minLength: 16
                  maxLength: 64
                  pattern: ^[A-Za-z0-9_-]+$
                  description: Journey Instance Id, a unique identifier for a started journey instance.
                scope:
                  type: array
                  items:
                    type: string
                    enum:
                    - mobile
                    - desktop
                    - '*'
                    - any
                    - ''
              required:
              - instanceId
              additionalProperties: {}
      responses:
        '201':
          description: Connect token created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceStartResponse'
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Cross-org access forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Journey not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      operationId: postJourneyDeviceStart
      x-operation-id-source: derived
    servers:
    - url: https://eu.platform.go.gbgplc.com/v2/captain/
    - url: https://us.platform.go.gbgplc.com/v2/captain/
    - url: https://au.platform.go.gbgplc.com/v2/captain/
    - url: https://api.auth.gbgplc.com/as/token.oauth2
  /journey/device/connect:
    post:
      tags:
      - Device
      summary: Complete the device-onboarding handshake
      description: Completes the device-onboarding handshake. See partner integration guide.
      security: []
      responses:
        '201':
          description: End-user token issued
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceConnectResponse'
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Invalid connect secret
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      operationId: postJourneyDeviceConnect
      x-operation-id-source: derived
    servers:
    - url: https://eu.platform.go.gbgplc.com/v2/captain/
    - url: https://us.platform.go.gbgplc.com/v2/captain/
    - url: https://au.platform.go.gbgplc.com/v2/captain/
    - url: https://api.auth.gbgplc.com/as/token.oauth2
  /journey/device/refresh:
    post:
      tags:
      - Device
      summary: Renew a device session
      description: Renews a device session. See partner integration guide.
      security: []
      responses:
        '201':
          description: Session renewed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceRefreshResponse'
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      operationId: postJourneyDeviceRefresh
      x-operation-id-source: derived
    servers:
    - url: https://eu.platform.go.gbgplc.com/v2/captain/
    - url: https://us.platform.go.gbgplc.com/v2/captain/
    - url: https://au.platform.go.gbgplc.com/v2/captain/
    - url: https://api.auth.gbgplc.com/as/token.oauth2
  /journey/device/validate:
    post:
      tags:
      - Device
      summary: Validate end-user session
      description: Validates an end-user JWT and returns session information.
      security:
      - InteractionAccess: []
      responses:
        '200':
          description: Session valid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceValidateResponse'
        '401':
          description: Invalid token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      operationId: postJourneyDeviceValidate
      x-operation-id-source: derived
    servers:
    - url: https://eu.platform.go.gbgplc.com/v2/captain/
    - url: https://us.platform.go.gbgplc.com/v2/captain/
    - url: https://au.platform.go.gbgplc.com/v2/captain/
    - url: https://api.auth.gbgplc.com/as/token.oauth2
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/GbgError'
          minItems: 1
      required:
      - errors
    DeviceRefreshResponse:
      type: object
      properties:
        endUserToken:
          type: string
        expiresIn:
          type: number
        instanceId:
          type: string
        resumeCredential:
          type: string
        credentialExpiresAt:
          type: string
        credentialExpiresIn:
          type: number
        linkExpiresAt:
          type: string
      required:
      - endUserToken
      - expiresIn
      - instanceId
      - resumeCredential
      - credentialExpiresAt
      - credentialExpiresIn
      - linkExpiresAt
    DeviceStartResponse:
      type: object
      properties:
        connectToken:
          type: string
        tokenType:
          type: string
          enum:
          - connect
        expiresIn:
          type: number
        scope:
          type: array
          items:
            type: string
      required:
      - connectToken
      - tokenType
      - expiresIn
      - scope
    DeviceValidateResponse:
      type: object
      properties:
        valid:
          type: boolean
          enum:
          - true
        sessionId:
          type: string
        instanceId:
          type: string
        orgId:
          type: string
        expiresAt:
          type: string
      required:
      - valid
      - sessionId
      - instanceId
      - orgId
      - expiresAt
    GbgError:
      type: object
      properties:
        code:
          type: string
          pattern: ^\d{4}$
        name:
          type: string
          minLength: 1
        problem:
          type: string
          minLength: 1
        action:
          type: string
          minLength: 1
        location:
          type: string
          enum:
          - Path
          - Authorization
          - Header
          - Query String
          - Request
          - Body
          - Service
          - Flow
      required:
      - code
      - name
      - problem
      - action
    DeviceConnectResponse:
      type: object
      properties:
        endUserToken:
          type: string
        tokenType:
          type: string
          enum:
          - end_user
        expiresIn:
          type: number
        instanceId:
          type: string
        resumeCredential:
          type: string
        credentialExpiresAt:
          type: string
        credentialExpiresIn:
          type: number
      required:
      - endUserToken
      - tokenType
      - expiresIn
      - instanceId
  securitySchemes:
    CustomerAccess:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Customer JWT token for journey lifecycle operations. Required for: journey/start, journey/state/fetch, device/start'
    InteractionAccess:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'End-User JWT token for end-user scoped operations. Required for: interaction/fetch, interaction/submit, device/validate'
x-refined-from:
- gbg-go-v2-openapi.json
- gbg-go-v2-openapi.yml