Skip to main content

What can I do with the Assignar Public API?

The Assignar Public API lets your own software read and send Assignar data, so you can automate common tasks and connect Assignar to systems that have no ready-made integration.

The Assignar Public API lets your own software read and send Assignar data, so you can automate common tasks and connect Assignar to systems that have no ready-made integration.

Using it requires technical knowledge of APIs. API access is a paid add-on that Assignar switches on for your company, and an admin with the Manage API Access permission gets the credentials from the Assignar dashboard.
​

What you can use the Assignar Public API for

With the Assignar Public API, your developers or a partner can:

  • Send data to Assignar, for example: create projects, clients, orders and order tasks, or attach documents to projects and orders

  • Read data from Assignar, for example timesheets, allocations, dockets, site diaries and form results, to feed your own reports or another system

  • Automate tasks you would otherwise do by hand on the Assignar dashboard.

The full list of what the API can do, with each endpoint, its fields and the responses, is in the Assignar API documentation at apidocs.assignar.com. On the dashboard, the link API documentation at the bottom of Settings > API Access opens it.

If you're not familiar with APIs, work with a partner or a developer who can build and look after the connection for you.

How do I get access to the Assignar Public API?

API access is a paid add-on and isn't switched on by default. To get it:

  1. Contact your Assignar Account Manager or Assignar Support to discuss access and pricing.

  2. Assignar switches on API access for your company.

  3. An admin with User Access Management gives the Manage API Access permission to whoever will manage the credentials. It's on the user's Access tab, under User & Access Control.

  4. That person opens Settings > API Access on the Assignar dashboard and clicks Setup to create the Client ID and Client Secret. See How do I create API credentials on the dashboard?.

Giving someone Manage API Access doesn't switch on API access by itself. Until Assignar switches it on for your company, API Access doesn't appear under Settings.
We recommend that only one user has access to the API setting so the client secret is not accidentally regenerated, breaking your connections

How the Assignar Public API signs in

Your software signs in to the Assignar Public API with your company's Client ID and Client Secret from Settings > API Access on the Assignar dashboard. Your company has one set of credentials, shared by every system you connect.

Your account's region also matters: Australia and New Zealand accounts are hosted in one region, and United States and Canada accounts in another. The API documentation explains how to request an access token and which address to use.

Keep the Client Secret private. If it may have been shared, regenerate it on Settings > API Access and update every system that uses it.

Why do I get "403 Forbidden" from the Assignar Public API?

A 403 Forbidden response from the Assignar Public API means your credentials were accepted but aren't allowed to do that request. API requests run with your company's API access, not with the access of the person who copied the credentials, so changing your own dashboard permissions doesn't fix it. Contact Assignar Support with the request you sent (the method and address, never the Client Secret) and the time it failed.

If you get an authentication error instead, check that you're using the current Client Secret (someone may have clicked Regenerate) and the right region for your account.

How do I match Assignar records to records in my own system?

Many Assignar records, such as orders, projects and clients, have an integration_id field. Your software can put its own ID for the record in that field when it creates or updates it, and later look the record up by it, for example ?integration_id=JOB-1042. On orders, each integration_id must be different from every other order in your company. You can leave it empty.

Can the Assignar Public API update an order's status?

Yes, the Assignar API can update an existing order, including its status, so another system can change an order automatically, for example to Confirmed when your client confirms a booking by SMS or email. Your developer sends the order's ID and the new status's ID in an order update request.

To find the IDs, request the list of order statuses (GET /order-statuses).

See How do I get all records and find IDs with the Public API?. The external system must send the ID of one of your company's order statuses, such as Pending, Confirmed or In Progress. The API documentation explains how to look them up.

The Assignar actions in Zapier include Create Order but not updating an order's status, so this needs the API. See How do I connect Assignar to Zapier?.

Can I get form results and their locations through the Assignar Public API?

Assignar stores the latitude and longitude of form results submitted from forms that have Activate Geolocation turned on. Whether the Assignar Public API returns form results, and their location, isn't something this article can confirm: check the API documentation at apidocs.assignar.com, or ask Assignar Support. Meanwhile, someone with an Insights Creator Licence can report on form results with their latitude and longitude in Insights and download them. See How does Assignar use workers' location data?.

What can't the Assignar Public API do yet?

The Assignar Public API can't currently:

  • Allocate workers or assets to orders or order tasks. Allocations can be read (GET /allocations) but not created or changed. Create the order and its tasks through the API, then allocate on the Scheduler on the Assignar dashboard.

  • Update or delete an order task. Order tasks can be created and read. To change or remove one, use the order on the Assignar dashboard.

  • Post order messages or daily notes. To put a link or a note on an order, send it in the order's comments field: it appears as the order's description on the dashboard.

  • Send SMS messages to workers.

Suggest a change to the Assignar Public API

Assignar adds new endpoints and features based on customer and partner feedback. To ask for one, contact Assignar Support and describe what you need the API to do and why.

Related articles

Did this answer your question?