> ## Documentation Index > Fetch the complete documentation index at: https://pearset/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve a QR code > Retrieve a QR code for a link. ## OpenAPI ````yaml get /qr openapi: 3.0.3 info: title: Pearset API description: >- Pearset is the modern link attribution platform for short links, conversion tracking, and affiliate programs. version: 0.0.1 contact: name: Pearset Support email: support@pearset url: https://pearset/support license: name: AGPL-3.0 license url: https://github.com/pearset/pearset/blob/main/LICENSE.md servers: - url: https://api.pearset description: Production API security: [] paths: /qr: get: tags: - QR Codes summary: Retrieve a QR code description: Retrieve a QR code for a link. operationId: getQRCode parameters: - in: query name: url schema: description: The URL to generate a QR code for. type: string maxLength: 32000 required: true description: The URL to generate a QR code for. - in: query name: logo schema: description: >- The logo to include in the QR code. Can only be used with a paid plan on Pearset. type: string description: >- The logo to include in the QR code. Can only be used with a paid plan on Pearset. - in: query name: size schema: default: 600 description: >- The size of the QR code in pixels. Defaults to `600` if not provided. type: number description: >- The size of the QR code in pixels. Defaults to `600` if not provided. - in: query name: level schema: default: L description: >- The level of error correction to use for the QR code. Defaults to `L` if not provided. type: string enum: - L - M - Q - H description: >- The level of error correction to use for the QR code. Defaults to `L` if not provided. - in: query name: fgColor schema: default: '#000000' description: >- The foreground color of the QR code in hex format. Defaults to `#000000` if not provided. type: string description: >- The foreground color of the QR code in hex format. Defaults to `#000000` if not provided. - in: query name: bgColor schema: default: '#FFFFFF' description: >- The background color of the QR code in hex format. Defaults to `#ffffff` if not provided. type: string description: >- The background color of the QR code in hex format. Defaults to `#ffffff` if not provided. - in: query name: hideLogo schema: default: false description: >- Whether to hide the logo in the QR code. Can only be used with a paid plan on Pearset. type: boolean description: >- Whether to hide the logo in the QR code. Can only be used with a paid plan on Pearset. - in: query name: margin schema: default: 2 description: >- The size of the margin around the QR code. Defaults to 2 if not provided. type: number description: >- The size of the margin around the QR code. Defaults to 2 if not provided. - in: query name: includeMargin schema: default: true description: >- DEPRECATED: Margin is included by default. Use the `margin` prop to customize the margin size. deprecated: true type: boolean description: >- DEPRECATED: Margin is included by default. Use the `margin` prop to customize the margin size. responses: '200': description: The QR code content: image/png: schema: type: string '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '409': $ref: '#/components/responses/409' '410': $ref: '#/components/responses/410' '422': $ref: '#/components/responses/422' '429': $ref: '#/components/responses/429' '500': $ref: '#/components/responses/500' x-codeSamples: - lang: go label: getQRCode source: "package main\n\nimport(\n\t\"context\"\n\tpearset \"github.com/pearset/pearset-go\"\n\t\"github.com/pearset/pearset-go/models/operations\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := pearset.New(\n pearset.WithSecurity(\"DUB_API_KEY\"),\n )\n\n res, err := s.QRCodes.Get(ctx, operations.GetQRCodeRequest{\n URL: \"https://needy-newsstand.biz/\",\n })\n if err != nil {\n log.Fatal(err)\n }\n if res != nil {\n // handle response\n }\n}" - lang: ruby label: getQRCode source: |- require 'pearset' Models = ::OpenApiSDK::Models s = ::OpenApiSDK::Pearset.new( security: Models::Shared::Security.new( token: 'DUB_API_KEY' ) ) req = Models::Operations::GetQRCodeRequest.new( url: 'https://needy-newsstand.biz/' ) res = s.qr_codes.get(request: req) unless res.nil? # handle response end - lang: typescript label: getQRCode source: |- import { Pearset } from "pearset"; const pearset = new Pearset({ token: "DUB_API_KEY", }); async function run() { const result = await pearset.qrCodes.get({ url: "https://needy-newsstand.biz/", }); console.log(result); } run(); - lang: python label: getQRCode source: |- from pearset import Pearset with Pearset( token="DUB_API_KEY", ) as d_client: res = d_client.qr_codes.get(request={ "url": "https://needy-newsstand.biz/", }) # Handle response print(res) - lang: php label: getQRCode source: |- declare(strict_types=1); require 'vendor/autoload.php'; use Pearset; use Pearset\Models\Operations; $sdk = Pearset\Pearset::builder() ->setSecurity( 'DUB_API_KEY' ) ->build(); $request = new Operations\GetQRCodeRequest( url: 'https://needy-newsstand.biz/', ); $response = $sdk->qrCodes->get( request: $request ); if ($response->res !== null) { // handle response } components: responses: '400': description: >- The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). content: application/json: schema: x-speakeasy-name-override: BadRequest type: object properties: error: type: object properties: code: type: string enum: - bad_request description: A short code indicating the error code returned. example: bad_request message: x-speakeasy-error-message: true type: string description: A human readable explanation of what went wrong. example: The requested resource was not found. doc_url: type: string description: >- A link to our documentation with more details about this error code example: https://pearset/docs/api-reference/errors#bad-request required: - code - message required: - error '401': description: >- Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. content: application/json: schema: x-speakeasy-name-override: Unauthorized type: object properties: error: type: object properties: code: type: string enum: - unauthorized description: A short code indicating the error code returned. example: unauthorized message: x-speakeasy-error-message: true type: string description: A human readable explanation of what went wrong. example: The requested resource was not found. doc_url: type: string description: >- A link to our documentation with more details about this error code example: https://pearset/docs/api-reference/errors#unauthorized required: - code - message required: - error '403': description: >- The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server. content: application/json: schema: x-speakeasy-name-override: Forbidden type: object properties: error: type: object properties: code: type: string enum: - forbidden description: A short code indicating the error code returned. example: forbidden message: x-speakeasy-error-message: true type: string description: A human readable explanation of what went wrong. example: The requested resource was not found. doc_url: type: string description: >- A link to our documentation with more details about this error code example: https://pearset/docs/api-reference/errors#forbidden required: - code - message required: - error '404': description: The server cannot find the requested resource. content: application/json: schema: x-speakeasy-name-override: NotFound type: object properties: error: type: object properties: code: type: string enum: - not_found description: A short code indicating the error code returned. example: not_found message: x-speakeasy-error-message: true type: string description: A human readable explanation of what went wrong. example: The requested resource was not found. doc_url: type: string description: >- A link to our documentation with more details about this error code example: https://pearset/docs/api-reference/errors#not-found required: - code - message required: - error '409': description: >- This response is sent when a request conflicts with the current state of the server. content: application/json: schema: x-speakeasy-name-override: Conflict type: object properties: error: type: object properties: code: type: string enum: - conflict description: A short code indicating the error code returned. example: conflict message: x-speakeasy-error-message: true type: string description: A human readable explanation of what went wrong. example: The requested resource was not found. doc_url: type: string description: >- A link to our documentation with more details about this error code example: https://pearset/docs/api-reference/errors#conflict required: - code - message required: - error '410': description: >- This response is sent when the requested content has been permanently deleted from server, with no forwarding address. content: application/json: schema: x-speakeasy-name-override: InviteExpired type: object properties: error: type: object properties: code: type: string enum: - invite_expired description: A short code indicating the error code returned. example: invite_expired message: x-speakeasy-error-message: true type: string description: A human readable explanation of what went wrong. example: The requested resource was not found. doc_url: type: string description: >- A link to our documentation with more details about this error code example: https://pearset/docs/api-reference/errors#invite-expired required: - code - message required: - error '422': description: >- The request was well-formed but was unable to be followed due to semantic errors. content: application/json: schema: x-speakeasy-name-override: UnprocessableEntity type: object properties: error: type: object properties: code: type: string enum: - unprocessable_entity description: A short code indicating the error code returned. example: unprocessable_entity message: x-speakeasy-error-message: true type: string description: A human readable explanation of what went wrong. example: The requested resource was not found. doc_url: type: string description: >- A link to our documentation with more details about this error code example: >- https://pearset/docs/api-reference/errors#unprocessable-entity required: - code - message required: - error '429': description: >- The user has sent too many requests in a given amount of time ("rate limiting") content: application/json: schema: x-speakeasy-name-override: RateLimitExceeded type: object properties: error: type: object properties: code: type: string enum: - rate_limit_exceeded description: A short code indicating the error code returned. example: rate_limit_exceeded message: x-speakeasy-error-message: true type: string description: A human readable explanation of what went wrong. example: The requested resource was not found. doc_url: type: string description: >- A link to our documentation with more details about this error code example: >- https://pearset/docs/api-reference/errors#rate-limit_exceeded required: - code - message required: - error '500': description: The server has encountered a situation it does not know how to handle. content: application/json: schema: x-speakeasy-name-override: InternalServerError type: object properties: error: type: object properties: code: type: string enum: - internal_server_error description: A short code indicating the error code returned. example: internal_server_error message: x-speakeasy-error-message: true type: string description: A human readable explanation of what went wrong. example: The requested resource was not found. doc_url: type: string description: >- A link to our documentation with more details about this error code example: >- https://pearset/docs/api-reference/errors#internal-server_error required: - code - message required: - error ````