QR Codes API Documentation

https://qrcodes.at/api-documentation
Admin
This documentation outlines the RESTful API endpoints for QR Codes, covering authentication, user...
Tokens:12,536
Snippets:53
Trust Score:6.8
Update:1 year ago
Show doc for...
Tokens:
Raw
### API Request Example (cURL)

Source: https://qrcodes.at/api-documentation/index

Demonstrates how to make a GET request to a qrcodes.at API endpoint using cURL. It includes the necessary URL structure and the Authorization header for Bearer Authentication with an API key.

```shell
curl --request GET \
  --url 'https://qrcodes.at/api/{endpoint}' \
  --header 'Authorization: Bearer {api_key}'
```

--------------------------------

### Curl Example for Link Statistics

Source: https://qrcodes.at/api-documentation/statistics

An example using curl to request link statistics from the qrcodes.at API, specifying a date range and including an authorization token.

```Shell
curl --request GET \
--url 'https://qrcodes.at/api/statistics/{link_id}?start_date=2020-01-01&end_date=2021-01-01' \
--header 'Authorization: Bearer {api_key}'
```

--------------------------------

### Retrieve Team Member - GET API

Source: https://qrcodes.at/api-documentation/team-members

Fetches a specific team member using their team ID. Requires an API key for authorization. The response includes member details, access permissions, and timestamps.

```curl
curl --request GET \
--url 'https://qrcodes.at/api/team-members/{team_id}' \
--header 'Authorization: Bearer {api_key}'
```

--------------------------------

### Create Link

Source: https://qrcodes.at/api-documentation/links

Creates a new link with specified parameters. Supports various options for URL aliasing, scheduling, targeting, and cloaking. Requires an API key and content type header.

```bash
curl --request POST \
  --url 'https://qrcodes.at/api/links' \
  --header 'Authorization: Bearer {api_key}' \
  --header 'Content-Type: multipart/form-data' \
  --form 'url=example' \
  --form 'location_url=https://qrcodes.at/' \

```

--------------------------------

### Retrieve All Links

Source: https://qrcodes.at/api-documentation/links

Fetches a list of all links. Supports pagination with 'page' and 'results_per_page' parameters. Requires an API key for authorization.

```bash
curl --request GET \
  --url 'https://qrcodes.at/api/links/' \
  --header 'Authorization: Bearer {api_key}' \

```

--------------------------------

### Retrieve all projects

Source: https://qrcodes.at/api-documentation/projects

Fetches a list of all projects. Supports pagination with 'page' and 'results_per_page' parameters. Requires an API key for authorization.

```curl
curl --request GET \
  --url 'https://qrcodes.at/api/projects/' \
  --header 'Authorization: Bearer {api_key}' \

```

--------------------------------

### Create a new project

Source: https://qrcodes.at/api-documentation/projects

Creates a new project with a required name and an optional color. Requires an API key and multipart/form-data content type.

```curl
curl --request POST \
  --url 'https://qrcodes.at/api/projects' \
  --header 'Authorization: Bearer {api_key}' \
  --header 'Content-Type: multipart/form-data' \
  --form 'name=Production' \
  --form 'color=#ffffff' \

```

--------------------------------

### Retrieve All Logs

Source: https://qrcodes.at/api-documentation/users-logs

Fetches a list of all log entries from the API. Supports pagination using 'page' and 'results_per_page' parameters. Requires an API key for authorization.

```curl
curl --request GET \
--url 'https://qrcodes.at/api/logs/' \
--header 'Authorization: Bearer {api_key}'
```

--------------------------------

### Retrieve User Information (API)

Source: https://qrcodes.at/api-documentation/user

This snippet shows how to retrieve a single user's information using the qrcodes.at API. It requires an API key for authentication. The endpoint returns user details including ID, email, and billing information.

```curl
curl --request GET \
--url 'https://qrcodes.at/api/user' \
--header 'Authorization: Bearer {api_key}'
```

--------------------------------

### Create Splash Page

Source: https://qrcodes.at/api-documentation/splash-pages

Creates a new splash page with various customizable options such as name, title, logo, description, custom CSS/JS, and redirect settings. Uses multipart/form-data for file uploads. Requires an API key.

```curl
curl --request POST \
  --url 'https://qrcodes.at/api/projects' \
  --header 'Authorization: Bearer {api_key}' \
  --header 'Content-Type: multipart/form-data' \
  --form 'name=Sample splash page' \
  --form 'title=Custom splash page title' \
  --form 'description=Custom splash page description' \

```

--------------------------------

### Create QR Code with Text

Source: https://qrcodes.at/api-documentation/qr-codes

This snippet demonstrates how to create a basic QR code containing text using the API. It specifies the name, type, and the text content for the QR code.

```bash
curl --request POST \
--url 'https://qrcodes.at/api/qr-codes' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=New York' \
--form 'type=text' \
--form 'text=Hello!' \

```

--------------------------------

### Retrieve a single project

Source: https://qrcodes.at/api-documentation/projects

Fetches details for a specific project using its ID. Requires an API key for authorization.

```curl
curl --request GET \
  --url 'https://qrcodes.at/api/projects/{project_id}' \
  --header 'Authorization: Bearer {api_key}' \

```

--------------------------------

### Retrieve All Data Entries

Source: https://qrcodes.at/api-documentation/data

Fetches a paginated list of all data entries. Supports optional parameters for page number and results per page. Requires an API key for authorization.

```curl
curl --request GET \
--url 'https://qrcodes.at/api/data/' \
--header 'Authorization: Bearer {api_key}'
```

--------------------------------

### Create Custom Domain

Source: https://qrcodes.at/api-documentation/domains

Creates a new custom domain. Requires the 'host' parameter and optionally accepts 'custom_index_url' and 'custom_not_found_url'. An API key is necessary for authentication.

```curl
curl --request POST \
--url 'https://qrcodes.at/api/domains' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'host=domain.com' \
--form 'custom_index_url=https://mywebsite.com/' \
--form 'custom_not_found_url=https://mywebsite.com/404-page'
```

--------------------------------

### Retrieve All Splash Pages

Source: https://qrcodes.at/api-documentation/splash-pages

Fetches a list of all splash pages. Supports pagination with 'page' and 'results_per_page' parameters. Requires an API key for authorization.

```curl
curl --request GET \
  --url 'https://qrcodes.at/api/splash-pages/' \
  --header 'Authorization: Bearer {api_key}' \

```

--------------------------------

### Retrieve All QR Codes

Source: https://qrcodes.at/api-documentation/qr-codes

Fetches a list of all QR codes with optional pagination. Supports filtering by page number and results per page. Requires an API key for authentication.

```curl
curl --request GET \
--url 'https://qrcodes.at/api/qr-codes/' \
--header 'Authorization: Bearer {api_key}'
```

--------------------------------

### Retrieve Single Link

Source: https://qrcodes.at/api-documentation/links

Fetches details for a specific link using its unique identifier. Requires an API key for authorization.

```bash
curl --request GET \
  --url 'https://qrcodes.at/api/links/{link_id}' \
  --header 'Authorization: Bearer {api_key}' \

```

--------------------------------

### Create Team

Source: https://qrcodes.at/api-documentation/teams

Creates a new team with a specified name. Requires an API key and the team name as form data.

```curl
curl --request POST \
--url 'https://qrcodes.at/api/teams' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=My team' \

```

--------------------------------

### Retrieve All Payments

Source: https://qrcodes.at/api-documentation/payments

Fetches a list of all payments with optional pagination. You can specify the page number and the number of results per page. Requires an API key for authorization.

```curl
curl --request GET \
--url 'https://qrcodes.at/api/payments/' \
--header 'Authorization: Bearer {api_key}'
```

--------------------------------

### Retrieve All Teams

Source: https://qrcodes.at/api-documentation/teams

Fetches a list of all teams, with options for pagination. Requires an API key for authorization.

```curl
curl --request GET \
--url 'https://qrcodes.at/api/teams/' \
--header 'Authorization: Bearer {api_key}' \

```

--------------------------------

### Retrieve All Pixels

Source: https://qrcodes.at/api-documentation/pixels

Fetches a list of all pixels with optional pagination. Requires an API key for authorization. Supports filtering by page number and results per page.

```curl
curl --request GET \
  --url 'https://qrcodes.at/api/pixels/' \
  --header 'Authorization: Bearer {api_key}' \

```

--------------------------------

### Update a project

Source: https://qrcodes.at/api-documentation/projects

Updates an existing project identified by its ID. Allows modification of the project's name and color. Requires an API key and multipart/form-data content type.

```curl
curl --request POST \
  --url 'https://qrcodes.at/api/projects/{project_id}' \
  --header 'Authorization: Bearer {api_key}' \
  --header 'Content-Type: multipart/form-data' \
  --form 'name=Production' \
  --form 'color=#000000' \

```

--------------------------------

### Retrieve All Custom Domains

Source: https://qrcodes.at/api-documentation/domains

Fetches a list of all custom domains associated with your account. Supports pagination with 'page' and 'results_per_page' parameters. Requires an API key for authorization.

```curl
curl --request GET \
--url 'https://qrcodes.at/api/domains/' \
--header 'Authorization: Bearer {api_key}' \

```

--------------------------------

### Create Team Member - POST API

Source: https://qrcodes.at/api-documentation/team-members

Creates a new team member with specified team ID, user email, and access permissions. Uses multipart/form-data for requests and requires an API key. Returns the ID of the created member.

```curl
curl --request POST \
--url 'https://qrcodes.at/api/team-members' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'team_id=1' \
--form 'user_email=hello@example.com'
```

--------------------------------

### Create Pixel

Source: https://qrcodes.at/api-documentation/pixels

Creates a new pixel with specified type, name, and pixel ID. Requires an API key for authorization and uses multipart/form-data for the request body.

```curl
curl --request POST \
  --url 'https://qrcodes.at/api/pixels' \
  --header 'Authorization: Bearer {api_key}' \
  --header 'Content-Type: multipart/form-data' \
  --form 'type=facebook' \
  --form 'name=Facebook' \
  --form 'pixel=12345678' \

```

--------------------------------

### Delete a project

Source: https://qrcodes.at/api-documentation/projects

Deletes a project using its ID. Requires an API key for authorization.

```curl
curl --request DELETE \
  --url 'https://qrcodes.at/api/projects/{project_id}' \
  --header 'Authorization: Bearer {api_key}' \

```

--------------------------------

### Retrieve Single Payment

Source: https://qrcodes.at/api-documentation/payments

Fetches details for a specific payment using its unique identifier. An API key is required for authentication.

```curl
curl --request GET \
--url 'https://qrcodes.at/api/payments/{payment_id}' \
--header 'Authorization: Bearer {api_key}'
```

--------------------------------

### Update Splash Page

Source: https://qrcodes.at/api-documentation/splash-pages

Updates an existing splash page identified by its ID. Allows modification of various properties including name, title, logo, description, and more. Uses multipart/form-data for file uploads. Requires an API key.

```curl
curl --request POST \
  --url 'https://qrcodes.at/api/splash-pages/{splash_page_id}' \
  --header 'Authorization: Bearer {api_key}' \
  --header 'Content-Type: multipart/form-data' \
  --form 'name=Sample splash page' \
  --form 'title=Custom splash page title' \
  --form 'description=Custom splash page description' \

```

--------------------------------

### Retrieve Single Data Entry

Source: https://qrcodes.at/api-documentation/data

Fetches a specific data entry by its unique identifier. Requires the data entry's ID and an API key for authentication.

```curl
curl --request GET \
--url 'https://qrcodes.at/api/data/{datum_id}' \
--header 'Authorization: Bearer {api_key}'
```

--------------------------------

### Retrieve Single Splash Page

Source: https://qrcodes.at/api-documentation/splash-pages

Fetches a specific splash page by its ID. Requires the splash page ID in the URL and an API key for authorization.

```curl
curl --request GET \
  --url 'https://qrcodes.at/api/splash-pages/{splash_page_id}' \
  --header 'Authorization: Bearer {api_key}' \

```

--------------------------------

### Retrieve All Team Members

Source: https://qrcodes.at/api-documentation/teams-member

Fetches a paginated list of all team members. Supports filtering by page number and results per page. Requires an API key for authorization.

```curl
curl --request GET \
--url 'https://qrcodes.at/api/teams-member/' \
--header 'Authorization: Bearer {api_key}' \

```

--------------------------------

### Retrieve Single Custom Domain

Source: https://qrcodes.at/api-documentation/domains

Fetches details for a specific custom domain using its unique ID. Requires an API key for authorization.

```curl
curl --request GET \
--url 'https://qrcodes.at/api/domains/{domain_id}' \
--header 'Authorization: Bearer {api_key}' \

```

--------------------------------

### Retrieve Link Statistics

Source: https://qrcodes.at/api-documentation/statistics

Fetches statistics for a specific link within a given date range. Supports various data types for detailed analysis.

```HTTP
GET https://qrcodes.at/api/statistics/{link_id}?start_date=2020-01-01&end_date=2021-01-01
Authorization: Bearer {api_key}
```

--------------------------------

### Update QR Code Link

Source: https://qrcodes.at/api-documentation/links

Updates an existing QR code link with new destination URLs, aliases, scheduling options, targeting parameters, and more. Requires an API key for authorization and accepts form data for updates.

```curl
curl --request POST \
--url 'https://qrcodes.at/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_enabled=0' \
```

--------------------------------

### Retrieve Single QR Code

Source: https://qrcodes.at/api-documentation/qr-codes

Fetches a specific QR code by its ID. This endpoint requires the QR code's unique identifier in the URL path and an API key for authentication.

```curl
curl --request GET \
--url 'https://qrcodes.at/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}'
```

--------------------------------

### Retrieve Single Team

Source: https://qrcodes.at/api-documentation/teams

Fetches details for a specific team using its ID. Requires an API key for authorization.

```curl
curl --request GET \
--url 'https://qrcodes.at/api/teams/{team_id}' \
--header 'Authorization: Bearer {api_key}' \

```

--------------------------------

### Retrieve Single Pixel

Source: https://qrcodes.at/api-documentation/pixels

Fetches a specific pixel by its ID. Requires an API key for authorization. The pixel ID is a path parameter.

```curl
curl --request GET \
  --url 'https://qrcodes.at/api/pixels/{pixel_id}' \
  --header 'Authorization: Bearer {api_key}' \

```

--------------------------------

### Update QR Code

Source: https://qrcodes.at/api-documentation/qr-codes

Updates an existing QR code with specified parameters. This endpoint supports various customization options for the QR code's content, style, colors, and data. It requires an API key for authentication and accepts form data for updates.

```curl
curl --request POST \
--url 'https://qrcodes.at/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Las Vegas' \
--form 'type=url' \
--form 'url=https://www.example.com' \
--form 'style=round' \
--form 'foreground_color=#000000' \
--form 'background_color=#FFFFFF'
```

--------------------------------

### Update Pixel

Source: https://qrcodes.at/api-documentation/pixels

Updates an existing pixel identified by its ID. Requires an API key for authorization. Allows optional updates to type, name, and pixel ID using multipart/form-data.

```curl
curl --request POST \
  --url 'https://qrcodes.at/api/pixels/{pixel_id}' \
  --header 'Authorization: Bearer {api_key}' \
  --header 'Content-Type: multipart/form-data' \
  --form 'name=Facebook New Name' \

```

--------------------------------

### Update Custom Domain

Source: https://qrcodes.at/api-documentation/domains

Updates an existing custom domain identified by its ID. You can modify 'host', 'custom_index_url', and 'custom_not_found_url'. Authentication is done via an API key.

```curl
curl --request POST \
--url 'https://qrcodes.at/api/domains/{domain_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'host=domain.com' \

```

--------------------------------

### Update Team

Source: https://qrcodes.at/api-documentation/teams

Updates an existing team's name using its ID. Requires an API key and the new team name as form data.

```curl
curl --request POST \
--url 'https://qrcodes.at/api/teams/{team_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=My new team name' \

```

--------------------------------

### Delete Data Entry

Source: https://qrcodes.at/api-documentation/data

Deletes a specific data entry using its unique identifier. Requires the data entry's ID and an API key for authorization.

```curl
curl --request DELETE \
--url 'https://qrcodes.at/api/data/{datum_id}' \
--header 'Authorization: Bearer {api_key}'
```

--------------------------------

### Retrieve Single Team Member

Source: https://qrcodes.at/api-documentation/teams-member

Fetches details for a specific team member using their unique ID. Requires an API key for authorization.

```curl
curl --request GET \
--url 'https://qrcodes.at/api/teams-member/{team_member_id}' \
--header 'Authorization: Bearer {api_key}' \

```

--------------------------------

### Delete Splash Page

Source: https://qrcodes.at/api-documentation/splash-pages

Deletes a splash page specified by its ID. Requires the splash page ID in the URL and an API key for authorization.

```curl
curl --request DELETE \
  --url 'https://qrcodes.at/api/splash-pages/{splash_page_id}' \
  --header 'Authorization: Bearer {api_key}' \

```

--------------------------------

### Update Team Member - POST API

Source: https://qrcodes.at/api-documentation/team-members

Updates an existing team member's access permissions using their team member ID. Accepts access levels as an array via multipart/form-data. Requires an API key for authentication. Returns the ID of the updated member.

```curl
curl --request POST \
--url 'https://qrcodes.at/api/team-members/{team_member_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'access[]=create' \
--form 'access[]=update'
```

--------------------------------

### Delete Team

Source: https://qrcodes.at/api-documentation/teams

Deletes a specific team using its ID. Requires an API key for authorization.

```curl
curl --request DELETE \
--url 'https://qrcodes.at/api/teams/{team_id}' \
--header 'Authorization: Bearer {api_key}' \

```

--------------------------------

### Delete Pixel

Source: https://qrcodes.at/api-documentation/pixels

Deletes a pixel by its ID. Requires an API key for authorization. The pixel ID is a path parameter.

```curl
curl --request DELETE \
  --url 'https://qrcodes.at/api/pixels/{pixel_id}' \
  --header 'Authorization: Bearer {api_key}' \

```

--------------------------------

### Delete Custom Domain

Source: https://qrcodes.at/api-documentation/domains

Deletes a custom domain using its unique identifier. An API key is required to authorize the request.

```curl
curl --request DELETE \
--url 'https://qrcodes.at/api/domains/{domain_id}' \
--header 'Authorization: Bearer {api_key}' \

```

--------------------------------

### Delete QR Code Link

Source: https://qrcodes.at/api-documentation/links

Deletes a specific QR code link using its unique identifier. This operation requires authentication with an API key.

```curl
curl --request DELETE \
--url 'https://qrcodes.at/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
```

--------------------------------

### Delete QR Code

Source: https://qrcodes.at/api-documentation/qr-codes

Deletes a specific QR code using its unique identifier. This operation requires authentication with an API key.

```curl
curl --request DELETE \
--url 'https://qrcodes.at/api/qr-codes/{qr_code_id}' \
--header 'Authorization: Bearer {api_key}'
```

--------------------------------

### Update Team Member Status

Source: https://qrcodes.at/api-documentation/teams-member

Updates the status of a specific team member. This endpoint uses the POST method and accepts form data for the status. Requires an API key for authorization.

```curl
curl --request POST \
--url 'https://qrcodes.at/api/teams-member/{team_member_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'status=1' \

```

--------------------------------

### Delete Team Member

Source: https://qrcodes.at/api-documentation/teams-member

Deletes a specific team member using their unique ID. Requires an API key for authorization.

```curl
curl --request DELETE \
--url 'https://qrcodes.at/api/teams-member/{team_member_id}' \
--header 'Authorization: Bearer {api_key}' \

```

--------------------------------

### Delete Team Member - DELETE API

Source: https://qrcodes.at/api-documentation/team-members

Deletes a team member identified by their team member ID. Requires an API key for authorization. This operation permanently removes the member from the team.

```curl
curl --request DELETE \
--url 'https://qrcodes.at/api/team-members/{team_member_id}' \
--header 'Authorization: Bearer {api_key}'
```
Tokens:
Raw