Skip to main content
Signing in to the G-P Developer Portal uses your organization’s single sign-on (SSO) provider. Create the application in the same G-P environment you plan to connect — credentials differ per environment, and Sandbox credentials only work against the Sandbox API.

Creating an API application

Applications on the G-P Developer Portal issue the Client ID and Client Secret that authorize API access. Credentials are not available on the G-P Platform itself.

1

Sign in to G-P

Sign in to the G-P Developer Portal for the environment you are connecting.

The developer portal log in card with the Continue with SSO button highlighted
2

Start a new application

Open the account menu in the upper right corner and select Applications. On the Applications page, click New application to open the Create an Application form.

The Applications page with the New application button highlighted
3

Enter the application details

Complete the Create an Application form.

  • Application name: a name for the integration, for example StackOne Integration
  • Auth strategy: the strategy for the environment you are connecting, for example G-P Auth Strategy Test for Test. A portal that serves two environments lists one strategy for each.
  • The Available scopes field appears once an auth strategy is selected.
The Create an Application form with the Application name field and the open Auth strategy list highlighted
4

Select the application scopes

Enables actions: Fetch Contract Amendments, Get Change Request, Get Contract, Get Contractor, Get Contractor Contract, Get Current Payroll, Get Customer, Get Employee, Get Employment, Get Employment Compensation, Get Invoice, Get Payroll History, Get Time Off Allowance, List Benefit Enrollments, List Benefit Entitlements, List Change Requests, List Contractor Contracts, List Contractors, List Employees, List Employments, List Invoices, List Jobs, List Time Off Allowances, Submit Change Request

Open Available scopes and select every scope in the list. Use Filter… to find each scope, and select the scopes one at a time.

The Available scopes dropdown open with the list of selectable scopes highlighted
5

Copy the credentials

Click Create application. The Application created successfully dialog displays the credentials for the new application.

  • Client ID: the public identifier of the application. Click the copy icon beside it and copy the Client ID across.
  • Client secret: the confidential key that authorizes the application. Click the copy icon beside it and copy the Client Secret across.
  • The client secret is only shown once.
  • Click Copy secret and close to dismiss the dialog.
The Application created successfully dialog with the copy icons for Client ID and Client secret highlighted and the values masked

Registering the G-P APIs

An application cannot call an API until that API is registered to it. Register the API sets that cover the scopes you selected.

1

Register the EOR and Contractor APIs

On the page of the application you just created, open the APIs tab and click Register an API. In the Add APIs panel, click Register on the EOR and Contractor API sets for your environment.

  • EOR: covers the employee, employment, contract, job, benefit, payroll, time off, customer, invoice, and change request scopes.
  • Contractor: covers the contractor and contractor contract scopes.
  • Outside Production the API sets carry an environment suffix — EOR - SANDBOX and Contractor - SANDBOX for Sandbox, EOR - TEST and Contractor - TEST for Test, EOR - DEV and Contractor - DEV for Dev. The panel lists five sets per page, so use the page numbers or Search APIs by name to find each one.
  • An API set that belongs to another environment shows This API uses a different authentication strategy. instead of a Register button.
  • Each API set shows the status approved once it is registered.
The Add APIs panel showing the EOR - TEST API set with its Register button highlighted

Find your Client ID

The Credentials tab of an application lists its Client ID, so you can retrieve it after leaving the creation dialog.

  • Open Applications from the account menu and select your application.
  • Open the Credentials tab.
  • If the client secret was not saved, click Refresh secret to issue a replacement, then copy the new Client Secret across.
The application Credentials tab listing the Client ID with the Refresh secret button highlighted
1

Connect

  • Click Connect.
  • If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider’s authorization flow.
  • Once authorization is successful, you will see a confirmation popup.
2

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.