Skip to main content

Farseer API Access

Create a Service User, assign it to a permissioned group, and use its API key to make authorized REST requests to the Farseer API.

Updated over a week ago

How to Gain API Access to Farseer

Accessing the Farseer API requires three steps:

  1. Create a Service User and generate an API key

  2. Assign the Service User to a permissioned user group

  3. Make your first authorized HTTP request

1. Create a Service User and Generate an API Key

Creating a new service user

  1. Open Users & Groups.

  2. Click Create service user.

  3. Set a name for the service user.

  4. A new API key will be generated—copy it and store it securely.

Once created, the Service User behaves like any other Farseer user but is intended exclusively for API integrations and does not consume a standard license.

2. Assign the Service User to a User Group with Permissions

Drag and drop the Service User into an existing user group that has the required permissions. This is the recommended approach, as it keeps permission management consistent and centralized.

While you can assign direct object-level permissions to the service user, this is normally discouraged—use groups instead.

3. Make Your First Authorized API Request

Use a tool such as curl to test your API key.

Before testing, ensure the Service User has sufficient permissions. For initial verification, you may temporarily place the Service User into the Super Admins group.

Example request:

curl "https://instanceName.farseer.io" \
  -H "X-API-key: yourApiKeyHere"A successful request returns JSON output (e.g., a list of tags).

If you remove the Service User from its permission group and repeat the request, you should receive:

Forbidden

This confirms that permissions are being correctly enforced.

Did this answer your question?