Sourceflow API (1.0.0)

This documentation details the API for the Sourceflow platform.

Where endpoints require authentication, it will be marked as OAuth2.0. Authentication uses the client credentials flow of OAuth 2.0. See https://auth0.com/docs/get-started/authentication-and-authorization-flow/client-credentials-flow for more information.

The token endpoint is /_sf/api/oauth/token.json. Authenticated endpoints require an Authorization header with the value Bearer TOKEN, where TOKEN is a UUID valid for 1 hour.

Base URL

The API is served from your own Sourceflow site's domain, not from this documentation site. Every endpoint is under /_sf/api/v1 on that domain, so an endpoint documented as /jobs/search.json is called at:

https://www.mybestwebsite.com/_sf/api/v1/jobs/search.json

There are three exceptions:

  • The token endpoint is on your site but outside /_sf/api/v1, at https://www.mybestwebsite.com/_sf/api/oauth/token.json.
  • The Customers endpoints are global rather than per-site, and are always called at https://app.sourceflow.co.uk/_sf/api/v1, whichever site is being managed.
  • The Images endpoints are served by a separate service at https://image-manager.sourceflow.co.uk.
Servers
Your Sourceflow site's API (replace `siteDomain` with your site's domain)
https://{siteDomain}/_sf/api/v1