> ## Documentation Index
> Fetch the complete documentation index at: https://docs.symmetry.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Postman collection and environment for SPF API

> Download the SPF Postman collection and environment directly from the API, set your credentials, and send sample requests to every Payroll Forms endpoint.

A Postman collection has been established to make testing the SPF API endpoints simple and intuitive. Symmetry serves the Postman files from the API itself rather than as static downloads, so the collection always reflects the current endpoints.

<Note>
  Onboarding employees in Canada? The endpoints and variables are the same. See [Canada](/spf/api-reference/postman-collection-canadian) for the Canadian sample requests.
</Note>

## Download from Swagger

Both files come from the **Postman** endpoints, and both require authorization.

| Endpoint                   | What it returns                                       |
| -------------------------- | ----------------------------------------------------- |
| `GET /postman/collection`  | Sample requests for all SPF API endpoints.            |
| `GET /postman/environment` | The environment variables used across those requests. |

<Card title="Postman endpoints in Swagger" icon="paper-plane" href="https://api.symmetry.com/spf/docs#/Postman">
  Jump to the Postman section of the Swagger UI to execute both endpoints and save each response.
</Card>

<Info>
  **Both endpoints require a JWT**

  Authorize with a JWT returned from the `/authentication/login` endpoint, not your API key or authorization hash. See [Symmetry Payroll Forms API overview](/spf/api-reference/overview) for how to request one.
</Info>

## Import into Postman

<Steps>
  <Step title="Authorize in Swagger and download both files">
    Authorize in the Swagger UI, then execute `GET /postman/collection` and `GET /postman/environment` and save each response as a file.
  </Step>

  <Step title="Import both files into Postman">
    In Postman, select **Import**, then add the collection file and the environment file you downloaded.
  </Step>

  <Step title="Select the environment and set your credentials">
    Activate the environment, then supply your own `apiKey` and point `apiDomain` at the environment you're testing against.
  </Step>
</Steps>

## Environment variables

| Variable         | Value                                                                                                                                                                                                                                       |
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `apiKey`         | Provided by Symmetry's Client Success team. If you are unsure of your company's `apiKey`, please reach out to Client Success within the [Client Support Center](https://support.symmetry.com).                                              |
| `apiDomain`      | The base domain for your target environment: `https://api.symmetry.com` for production, `https://api-staging.symmetry.com` for staging.                                                                                                     |
| `accessToken` \* | Provided in the response from the `/authentication/login` endpoint.                                                                                                                                                                         |
| `formId`         | ID of the current form. The `getAllFormIds` endpoint returns a list of all form IDs currently supported by the Symmetry Payroll Forms API. A list of up-to-date form IDs can also be found in the SPF catalog.                              |
| `flowId`         | ID of the flow used to identify the specific form(s) an employee may be required to complete for proper payroll withholdings. When you supply the address information to the `guided-flows` endpoint, the applicable flow IDs are returned. |
| `questionSetId`  | ID of the question set used to filter the list of potentially applicable forms down to a list of required forms. The `flowQuestionSet` endpoint returns a question set ID for a given flow.                                                 |

\* Set automatically in Postman after an authentication call. You do not need to enter a value when you set up your environment file.