Public API v1

The Integration API provides integration with other applications and provides access to the Public API.

Overview

This describes the resources that make up the official StarMeUp REST API v1. If you have any problems or requests, please contact StarMeUp Support.

Current version
Schema
Authentication

Products

We expose Public API’s to build an integration with these products listed below:

Current version

By default, all requests to https://integration.starmeup.com/ receive the v1 version of the REST API.

Schema

All API access is over HTTPS, and accessed from https://integration.starmeup.com/. All data is sent and received as JSON.

Blank fields are included as null instead of being omitted.

All timestamps return in ISO 8601 format when they are not part of an error message:

  YYYY-MM-DDTHH:MM:SSZ

Responses

Single Object

HTTP/1.1 200 OK

Example:

  {
    "result": {
    }
  }

List

HTTP/1.1 200 OK - With objects

Example:

  {
    "result": [
      {
      }
    ],
    "page": {
      "number": 0,
      "numberOfElements": 0,
      "size": 0,
      "totalElements": 0,
      "totalPages": 0
    }
  }

Errors

HTTP/1.1 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable

Example:

  {
    "timestamp": "2019-06-26",
    "message": "Internal Server Error",
    "details": "The user wasn’t found",
    "type": "uri=/starmeup/public-api/v1/kudos",
    "title": "Internal Server Error",
    "detail": "An unexpected or uncontrolled error has occurred in the application."
  }

Authentication

As part of each request you must provide a Community Token. Community Token is a JWT token that allows your company to be integrated with our API. It will be provided to you by your integration. To use it, all you need to do is add a header property called Authorization and its value you must provide a string with the structure:

Bearer {community-token}

To get a token value please send an email to StarMeUp Support to ask for it.