---
title: "Get authorization codes."
method: GET
path: "/api/v2/AuthorizationCodes"
tags: ["AuthorizationCodes"]
---

# Get authorization codes.

`GET /api/v2/AuthorizationCodes`

## Request

- Base URL: `https://secure.agco-ats.com`
- URL: `https://secure.agco-ats.com/api/v2/AuthorizationCodes`
- Auth: none declared

Additional searches: validationParameters[Name]=Value and dataParameters[Name]=Value. These can be used to search for authorization codes that have been generated using specified values for data or validation parameters.

## Query parameters

- `code` string
- `limit` integer
- `offset` integer
- `definitionID` string
- `createdByUserID` integer
- `deletedByUserID` integer
- `includeDeleted` boolean

## Response `200`

OK

- APIIPagedResponseAuthorizationCodesSharedModelsAuthorizationCode
  - `Entities` AuthorizationCodesSharedModelsAuthorizationCode[]
    - `ID` integer: The identifier for the authorization code. Read only.
    - `Code` string: The code to enter to unlock a feature. Read only.
    - `DefinitionID` string: The id of the definition for this authorization code. May not be updated.
    - `ValidationParameters` AuthorizationCodesSharedModelsParameter[]: The parameters and values used to validate this authorization code. May not be updated.
      - `Name` string, required: The name of the parameter. May not be updated.
      - `Value` string, required: The value of the parameter. May not be updated.
    - `DataParameters` AuthorizationCodesSharedModelsParameter[]: The parameters and values contained as data in this authorization code. May not be updated.
      - `Name` string, required: The name of the parameter. May not be updated.
      - `Value` string, required: The value of the parameter. May not be updated.
    - `CreatedByUserID` integer: The ID of the user that created this authorization code. Read only.
    - `CreatedDate` string, date-time: A timestamp of when this code was created. Read only.
    - `IsDeleted` boolean: Indicates whether this code is deleted.
    - `DeletedByUserID` integer: The ID of the user that deleted this authorization code. Read only.
    - `DeletedDate` string, date-time: A timestamp of when this authorization code was deleted. Read only.
    - `EffectiveDate` string, date-time: A date at which this code should begin being valid. Optional. Set on create only.
  - `Metadata` APIPagedResponseMetadata: Metadata for the paged response
    - `TotalCount` integer, required: The total number of entities matching the request.
    - `Limit` integer, required: The number of entities this paged response is limited to.
    - `Offset` integer, required: The number of entities prior to this page of items.

## Other responses

- `default`: API Error Response

---

[API](https://skmtc.dev/agco-ats/apis/agco-ats-api.md) - [All operations](https://skmtc.dev/agco-ats/apis/agco-ats-api/llms.txt) - [OpenAPI document](https://skmtc.dev/agco-ats/apis/agco-ats-api/revisions/8b416443df5c?raw)