Get Started with Planning Data Load API

Everything you need to know to get started with the Planning Data Load API.

Get a Visier account

To use the APIs, you must have a Visier account with a profile that has the API capability. If you don't have an account, contact your administrator. They will create an account for you with permissions that allow you to view data.

In addition to an API profile, your API user must have permission to edit the plan. For more information, see Planning Capabilities.

If the plan is a managed plan and you're adding or removing rows, you must have access to all plan items in the plan. For more information, see Set Managed Plan Security.

Generate your API key and security token

To make an API request, you will need an API key and a security token. For more information about how to get an API key and request a security token, see API Authentication.

Note: If using Postman to send requests, you can request a security token directly in the tool, see Use Postman to Call Visier APIs.

Choose your tool

To use Visier APIs, you need to choose a tool to make your first request. This can be Postman or whichever method you usually use to make HTTP requests. For more information about using Postman for your first request, see Use Postman to Call Visier APIs.

Put your data files in the right place

To send data files using the API, the data files must be in a location that your API application can access. If using Postman, the data files you want to upload must be in Postman's files folder on your local device. For more information, see "Working directory" in Setting up Postman.

Make your first request

To test that you have access to plan APIs, make a request to the Retrieve a list of plans endpoint. For a complete list of available endpoints, see "Planning Data Load" in API Reference.

Replace {vanity_name} with your tenant name. The API key is expected as a header, while the security token is expected as a cookie.

Tip:

To find your vanity name:

In Visier, in the global workspace, click Settings > Single Sign-On.
Under Single Sign-On, find your service provider endpoint; for example, https://jupiter.visier.com/VServer/auth. In this example, jupiter is the vanity name.

Copy

Retrieve a list of plans

1
2
3
curl -X GET --url 'https://jupiter.api.visier.io/v1alpha/planning/model/plans' \
-H 'apikey:{api_key}' \
-H 'Cookie:VisierASIDToken={security_token}'

If everything was set up correctly and the request was successful, you should see a similar response:

Copy

Sample response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
{
    "plans": [
      {
        "uuid": "93668189-8734-4cd8-b340-e9bb9f4a38f0",
        "displayName":"“Workforce Plan FY 2025",
        "modelId": "WorkforcePlanModel",
        "scenarios": [
          {
            "uuid": "7af12ba3-6e7a-453e-924e-0585ba22b8c6",
            "displayName": "Default"
          }
        ],
        "currencyCode": "USD"
      },
      {
        "uuid": "b9759dbb-855f-4229-a7a3-937c14a88ffc",
        "displayName": "Headcount FY2024",
        "modelId": "Headcount_And_Cost_Planning",
        "scenarios": [
          {
            "uuid": "a7f039c7-1c44-48cd-aa57-89c93d445bf3",
            "displayName": "Default"
          }
        ],
        "currencyCode": "USD"
      },
      {
        "uuid": "31468b5e-41e0-4fdc-86ae-39a94dc5e337",
        "displayName": "Headcount Plan FY2023",
        "modelId": "Headcount_And_Cost_Planning",
        "scenarios": [
          {
            "uuid": "a7f039c7-1c44-48cd-aa57-89c93d445bf3",
            "displayName": "Default"
          }
        ],
        "currencyCode": "USD"
      },
      {
        "uuid": "04120831-7cb5-461a-affc-3f50816300e3",
        "displayName": "Workforce and Cost Plan for FY 2025",
        "modelId": "Headcount_And_Cost_Planning",
        "scenarios": [
          {
            "uuid": "a7f039c7-1c44-48cd-aa57-89c93d445bf3",
            "displayName": "Default"
          }
        ],
        "currencyCode": "USD"
      },
    ],
    "page": 1
}

Next steps

Now that you've successfully authenticated and completed your first API request, you can call more Visier APIs!

To learn more:

Explore the Planning Data Load API Code Samples.
Review the Planning Data Load API Reference.