---
title: "API: listRequirements"
slug: "api-listrequirements"
updated: 2022-09-12T16:57:45Z
published: 2022-09-12T16:57:45Z
canonical: "support.smarteru.com/api-listrequirements"
---

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

# API: listRequirements

- Starting June 1, 2022, SmarterU will require all API calls to POST to HTTPS. Any POST to HTTP will result in the SU:01 error (i.e., No POST data detected.).
- If you are viewing the help in a language other than English, please change your language to English before copying and pasting any code. All API attributes and functions are in English.
- Tags are required unless specified.

## **Description**

The listRequirements method retrieves [requirements](/v1/docs/requirements) that meet the specified filters.

## **Who Has Access**

The following users have access to the listRequirements method:

- Users with the [Manage Learning Plans, Certifications, and Requirements](/v1/docs/account-permission-manage-learning-plans-certifications-and-requirements) account permission.
- [Administrators and owners](/v1/docs/user-profile-information#access-level).

## **API Call XML Package**

```markup
<SmarterU>
   <AccountAPI><![CDATA[]]></AccountAPI>
   <UserAPI><![CDATA[]]></UserAPI>
   <Method>listRequirements</Method>
   <Parameters>
      <Requirement>
         <Page></Page>
         <Filters>
            <RequirementStatus></RequirementStatus>
         </Filters>
      </Requirement>
   </Parameters>
</SmarterU>
```

## **Requirement Tag Group**

The Requirement tag group is a container for how the response is returned and the requirement filters.

```markup
<Requirement>
   <Page></Page>
   <Filters>
      <RequirementStatus></RequirementStatus>
   </Filters> 
</Requirement>
```

The Requirement tag may contain the following tags:

### Page (optional)

The page number to return. The default is *1*. Up to 50 results are returned by default.

### Filters (optional)

A container for the requirement status filter. This tag contains the following.

| Tag | Description |
| --- | --- |
| **RequirementStatus** | The requirement's status. Acceptable values are *Active*, *Inactive*, or *All*. The default is *All*. |

## API Response XML Package

The [API response XML package](/v1/docs/api-response-xml-package) will always include a Result, Info, and [Errors](/v1/docs/api-listrequirements#error-codes) tag.

```markup
<SmarterU>
   <Result></Result>
   <Info>
      <Requirement>
        <Requirement>
          <Name><![CDATA[]]></Name>
          <Status></Status>
        </Requirement>
     </Requirement>
   </Info>

   <Errors>
      <Error>
         <ErrorID></ErrorID>
         <ErrorMessage></ErrorMessage>
      </Error>
   </Errors>
</SmarterU>
```

The Requirement tag is a container for the requirements returned by the listRequirements method. Each requirement is contained in a Requirement tag and may contain the following.

### Name

The [requirement's name](/v1/docs/requirement-main#name).

### Status

The [requirement's status](/v1/docs/requirement-main#status).

### Example API Response XML Package

Below is an example of an API response XML package.

```markup
<SmarterU>
   <Result>Success</Result>
   <Info>
      <Requirement>
        <Requirement>
          <Name><![CDATA[Call Center Customer Service]]></Name>
          <Status>Active</Status>
        </Requirement>

        <Requirement>
           <Name><![CDATA[Forklift Operator]]></Name>
           <Status>Active</Status>
        </Requirement>

        <Requirement>
           <Name><![CDATA[Retail Merchandising]]></Name>
           <Status>Active</Status>
        </Requirement>
     </Requirement>
   </Info>

   <Errors>
   </Errors>
</SmarterU>
```

## **Error Codes**

| Error Code | Message |
| --- | --- |
| LR:01 | The page provided is invalid. |
| LR:02 | The filters provided is invalid. |
| LR:03 | The requirement status provided is invalid. |
| LR:04 | The required permissions are not met to call the listRequirements method. |
| LR:05 | The value for a requirement status must be Active, Inactive, or All. |

## Related

- [API: createRequirement](/api-createrequirement.md)
- [API: getRequirement](/api-getrequirement.md)
- [API: updateRequirement](/api-updaterequirement.md)
- [Requirements](/requirements.md)